mirror of
https://github.com/tiennm99/tsuki.git
synced 2026-06-04 02:14:18 +00:00
tiennm99
5f023450a2
Update theme.toml with v0.2.0, configure module mounts for clean theme structure, add comprehensive installation documentation.
109 lines
3.1 KiB
Markdown
109 lines
3.1 KiB
Markdown
# Installation
|
|
|
|
tsuki supports two install methods. Pick the one that matches your team's tooling.
|
|
|
|
## Git submodule
|
|
|
|
```bash
|
|
git submodule add https://github.com/tiennm99/tsuki.git themes/tsuki
|
|
git submodule update --init --recursive
|
|
```
|
|
|
|
In your site `hugo.yaml`:
|
|
|
|
```yaml
|
|
theme: tsuki
|
|
```
|
|
|
|
Pin to a specific version:
|
|
|
|
```bash
|
|
cd themes/tsuki && git checkout v0.2.0 && cd -
|
|
git add themes/tsuki && git commit -m "chore: pin tsuki to v0.2.0"
|
|
```
|
|
|
|
## Hugo Module
|
|
|
|
Requires Go installed locally (Hugo Modules use Go's module system).
|
|
|
|
```bash
|
|
hugo mod init github.com/<you>/<your-site>
|
|
hugo mod get github.com/tiennm99/tsuki@latest
|
|
```
|
|
|
|
In your site `hugo.yaml`:
|
|
|
|
```yaml
|
|
module:
|
|
imports:
|
|
- path: github.com/tiennm99/tsuki
|
|
```
|
|
|
|
Update later with `hugo mod get -u github.com/tiennm99/tsuki`.
|
|
|
|
## Required site config
|
|
|
|
Hugo does not deep-merge nested config from themes — duplicate these into your *site* `hugo.yaml`. See [`config.md`](config.md) for the full block; the minimum is:
|
|
|
|
```yaml
|
|
languageCode: vi
|
|
defaultContentLanguage: vi
|
|
pagination: { pagerSize: 10, path: page }
|
|
taxonomies: { category: categories, tag: tags }
|
|
permalinks: { post: /:year/:month/:day/:contentbasename/ }
|
|
markup:
|
|
goldmark:
|
|
renderer: { unsafe: true }
|
|
parser: { autoHeadingIDType: github-ascii }
|
|
related:
|
|
threshold: 80
|
|
includeNewer: true
|
|
toLower: true
|
|
indices:
|
|
- { name: tags, weight: 100 }
|
|
- { name: categories, weight: 60 }
|
|
- { name: date, weight: 10 }
|
|
```
|
|
|
|
Drop a `data/profile.yaml` and `data/projects.yaml` next; see [`data-schemas.md`](data-schemas.md).
|
|
|
|
## Pagefind search
|
|
|
|
Pagefind indexes content **after** Hugo builds. The theme assumes you run it as part of your build pipeline — it's not bundled into the layout.
|
|
|
|
### For submodule users
|
|
|
|
`tsuki/package.json` pins Pagefind. From your site root, after Hugo builds:
|
|
|
|
```bash
|
|
cd themes/tsuki && npm ci && cd -
|
|
npx --prefix themes/tsuki pagefind --site public
|
|
```
|
|
|
|
Or simpler: install Pagefind in your own site `package.json` and run `npx pagefind --site public`.
|
|
|
|
### For Hugo Module users
|
|
|
|
Hugo Modules ignore `package.json` — it lives outside the module graph. Add Pagefind to your *site's* package.json:
|
|
|
|
```bash
|
|
npm init -y
|
|
npm install --save-dev pagefind
|
|
```
|
|
|
|
Then in CI, run `npx pagefind --site public` after `hugo`. The supplied [`.github/workflows/pages.yml`](https://github.com/tiennm99/tsuki/blob/main/.github/workflows/pages.yml) is a drop-in template.
|
|
|
|
If you don't want search at all, set `params.search.enable: false` in your `hugo.yaml` and skip the Pagefind step entirely.
|
|
|
|
## Verify
|
|
|
|
After installing, run `hugo server -s exampleSite` (if cloned) or `hugo server` from your own site. You should see:
|
|
|
|
- Homepage with hero, optional projects grid, recent posts
|
|
- `/post/` list with pagination
|
|
- `/tags/<slug>/`, `/categories/<slug>/`, `/archives/`
|
|
- Single post with reading-time byline, callouts (if used), related posts at the bottom
|
|
- `<head>` containing OG, Twitter, JSON-LD on posts; `<meta name=generator content="tsuki">`
|
|
|
|
If something looks off, see [`customization.md`](customization.md) for override patterns or open an issue.
|