tiennm99
bde8b8de63
The 7-phase v0.2.0 implementation roadmap is shipped (commits 6e17ee6..5d73a13). Move it under plans/archive/ so plans/ root only shows active work. Add plans/260509-0947-v0.2.0-prerelease-checklist/ capturing what's left before the v0.2.0 tag and gallery submission: action SHA pin, phase-07 plan-todo accuracy fix, CI watch, journal, tag, plus maintainer decisions (Q1 unsafe Goldmark, Q3 audience) and external tasks (hugoBasicExample smoke, hugoThemes registry PR).
tsuki (月)
A Hugo blog + personal portfolio theme. The homepage is the portfolio — bio, featured projects, recent posts. Posts live at /post/. Vietnamese-first typography, View Transitions on navigation, Pagefind search, Giscus comments.
月 (tsuki): the moon. Quiet, observed, returned to. Companion to
bonsaiin the same naming family.
Status
v0.1.0 — initial release. See CHANGELOG.md.
Features
- Blog — posts, tags, categories, year-grouped archive, paginated post list
- Personal portfolio on the homepage — driven by
data/profile.yaml+data/projects.yaml, no separate/portfoliosection - Search — Pagefind, zero-runtime, indexed at build time
- Comments — Giscus (GitHub Discussions)
- Vietnamese-first — diacritic-safe typography, native vi date formats, ASCII heading IDs
- Dark mode —
prefers-color-scheme+ persistent toggle, no flash of wrong theme - View Transitions API — smooth same-document navigation in supporting browsers
- Table of contents — auto-mounted on long posts, sticky on wide viewports, IntersectionObserver active highlight
- No build step — pure Hugo + browser ES modules. No SCSS, no TypeScript, no bundler in the theme
- Light — CSS ≤ 4 KB gz, JS ≤ 1 KB gz (excluding Pagefind UI)
Quick start
git submodule add https://github.com/tiennm99/tsuki.git themes/tsuki
echo 'theme: tsuki' >> hugo.yaml
Full installation guide (submodule, Hugo Module, Pagefind setup, required site config): docs/installation.md.
exampleSite/hugo.yaml is a complete working example.
Documentation
docs/installation.md— submodule + Hugo Module + Pagefind setupdocs/config.md— full params referencedocs/data-schemas.md—profile.yaml+projects.yamldocs/customization.md— override layouts, tokens, fonts, calloutsdocs/migrating-from-stack.md— for users coming fromhugo-theme-stack
Search and comments
Search uses Pagefind, built post-Hugo via npx pagefind --site public. tsuki pins Pagefind in its own package.json for submodule consumers; Hugo Module consumers install Pagefind in their own site (see docs/installation.md). No runtime dependency.
Comments use Giscus. Generate config at giscus.app and add to params.comments.giscus.* to enable. Defaults to off.
Browser support
Modern evergreen browsers. View Transitions and :has() are progressive enhancements; the theme remains functional without them.