Skip to content

Update docs #513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 35 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,24 @@ Castanet is a Hugo theme for podcast websites. To install and use Castanet, foll
Initialize Hugo modules in your site root:

```sh
hugo mod init
hugo mod init <YOUR_REPO_NAME>
```

Add Castanet as a module:

```toml
# hugo.toml
[module]
[module.hugoVersion]
[[module.imports]]
path = "github.com/mattstratton/castanet/v2"
[[module.mounts]]
source = 'assets'
target = 'assets'
[[module.mounts]]
disableWatch = true
source = 'hugo_stats.json'
target = 'assets/notwatching/hugo_stats.json'
```

## 2. Install Node.js Dependencies
Expand All @@ -35,14 +43,38 @@ npm install

## 3. Configure Your Site

Set the build settings:

```toml
# hugo.toml
[build]
[build.buildStats]
enable = true
[[build.cachebusters]]
source = 'assets/notwatching/hugo_stats.json'
target = 'css'
[[build.cachebusters]]
source = '(postcss|tailwind).config.js'
target = 'css'
```

Configure the output settings:

```toml
# hugo.toml
[outputs]
home = ["HTML", "RSS", "JSON"]
page = ["HTML", "RSS"]
```

See the [Main Configuration](./main-configuration.md) for required and optional settings.

## 4. Build the Site

To build your site:

```sh
npm run build
hugo --gc
```

The generated site will be in `public`.
Expand All @@ -52,7 +84,7 @@ The generated site will be in `public`.
To serve your site locally:

```sh
hugo server -s exampleSite
hugo server --gc
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This guide helps you migrate your podcast site to Castanet.
- Guests must now be created at pages in the `content/guest/` folder. Support for datafiles for guests has been removed.
- If you used a custom color template (i.e. `static/scss/COLOR-variables.scss`), this is no longer supported. Instead, copy [slate.scss](../assets/css/slate.scss) to `css/COLOR.css` in your site's `assets` folder and customize that. You can use https://uicolors.app/ to generate a color palette.
- For optimal performance, copy all images from `static/img` to your site's `assets/img` folder.

## From Other Podcast Themes

- Copy your content (episodes, guests, hosts) into the appropriate `content/` folders.
Expand Down Expand Up @@ -40,7 +41,6 @@ If you have guest data in YAML files (in `data/guests/`), you can convert them t
sh docs/utils/guest-yml-to-md.sh
```

- This script requires only standard Unix tools (POSIX shell, grep, sed, awk, mkdir, etc). No extra dependencies are needed.
- It will create a Markdown file for each guest YAML file, using the YAML fields as front matter and the `bio` as the main content.
- Existing files in `content/guest/` with the same name will be overwritten.
- You may need to adjust the script if your YAML files use custom fields or formats.
Expand Down
2 changes: 1 addition & 1 deletion exampleSite/config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ googleAnalytics_UA = ""
mainSections = ["episode"]
episode_number_style = "brackets"
episode_number_prefix = "CWC"
colorScheme = "slate"
colorScheme = "pagerduty"
# site_layout = "grid"
site_layout = "grid"
show_next_upcoming = "true"
Expand Down