|
| 1 | +# cnck-blog.github.io |
| 2 | + |
| 3 | +The [CNCK blog](https://cnck-blog.github.io), built with [Zola](https://www.getzola.org) 0.22 and the **CNCK** theme. |
| 4 | + |
| 5 | +CNCK is a minimal monochrome Zola theme: serif body text, monospaced metadata, generous whitespace, and a light/dark toggle that follows the OS preference until you override it. |
| 6 | + |
| 7 | +## Requirements |
| 8 | + |
| 9 | +- [Zola](https://www.getzola.org/documentation/getting-started/installation/) `0.22.x` |
| 10 | + |
| 11 | +## Local development |
| 12 | + |
| 13 | +```bash |
| 14 | +zola serve # live reload at http://127.0.0.1:1111 |
| 15 | +zola build # output to ./public |
| 16 | +zola check # validate links and content |
| 17 | +``` |
| 18 | + |
| 19 | +## Structure |
| 20 | + |
| 21 | +``` |
| 22 | +. |
| 23 | +βββ config.toml # site configuration |
| 24 | +βββ content/ # markdown content |
| 25 | +β βββ _index.md # home page intro |
| 26 | +β βββ about.md # about page |
| 27 | +β βββ blog/ # posts (sorted by date) |
| 28 | +βββ static/ # static assets served at / |
| 29 | +βββ themes/cnck/ # the CNCK theme |
| 30 | +β βββ theme.toml |
| 31 | +β βββ templates/ # Tera templates |
| 32 | +β βββ sass/ # stylesheets (compiled by Zola) |
| 33 | +β βββ static/js/ # theme toggle script |
| 34 | +βββ .github/workflows/ # GitHub Pages deploy |
| 35 | +``` |
| 36 | + |
| 37 | +## Writing a post |
| 38 | + |
| 39 | +Create `content/blog/<slug>.md`: |
| 40 | + |
| 41 | +```toml |
| 42 | ++++ |
| 43 | +title = "Post title" |
| 44 | +date = 2026-06-01 |
| 45 | +description = "One-line summary used for meta tags and listings." |
| 46 | +[taxonomies] |
| 47 | +tags = ["kubernetes", "rust"] |
| 48 | +[extra] |
| 49 | +toc = true # render a table of contents |
| 50 | ++++ |
| 51 | + |
| 52 | +Body in Markdown. |
| 53 | +``` |
| 54 | + |
| 55 | +## Configuration |
| 56 | + |
| 57 | +Site-wide options live in `config.toml`. The theme reads these `[extra]` keys: |
| 58 | + |
| 59 | +- `author`, `author_url` β used in footer and meta tags |
| 60 | +- `tagline` β shown under the title on the home page |
| 61 | +- `nav` β header navigation links |
| 62 | +- `social` β footer links |
| 63 | +- `theme_switcher` β show the light/dark toggle |
| 64 | + |
| 65 | +## Deployment |
| 66 | + |
| 67 | +Pushing to `main` triggers `.github/workflows/deploy.yml`, which installs Zola, builds the site, and publishes it to GitHub Pages. Enable **Settings β Pages β Source: GitHub Actions** once on the repository. |
| 68 | + |
| 69 | +## License |
| 70 | + |
| 71 | +Theme code is MIT licensed. Post content is Β© the author. |
0 commit comments