Color mode

Guides

Guides start from a task: "I want to publish an Obsidian vault", "I want a multilingual site", "I want to deploy automatically". If you are new, finish Getting Started first.

By task

I want to… Guide
Write and organize articles Writing content
Customize the site UI with HonoX Customizing your site
Build a homepage and browse routes Discovery recipes
Publish an Obsidian vault Obsidian
Keep content and the site in separate repositories Content repositories
Build a multilingual site Localization
Collect page views Analytics
Replace the icon, logo, or link preview image Branding your site
Deploy Deployment
Upgrade Riebeckite or read migration notes Upgrading

Deployment guides

Deployment has its own section because the choices multiply once automation is involved.

I want to… Guide
Deploy to Cloudflare Workers Cloudflare Workers
Understand the generated GitHub Actions workflow GitHub Actions
Read articles from a separate repository in CI Separate content repository

Where to look next

  • The exact configuration fields, CLI commands, and API contracts live in Reference.
  • How the content, plugin, and theme systems are built lives in Framework.

History

1 changesCollapseExpand
1 + ---
2 + title: Guides
3 + sidebar:
4 + label: Guides
5 + order: 20
6 + ---
7 + # Guides
8 +
9 + Guides start from a task: "I want to publish an Obsidian vault", "I want a multilingual site", "I want to deploy automatically". If you are new, finish [Getting Started](../getting-started/README.en.md) first.
10 +
11 + ## By task
12 +
13 + | I want to… | Guide |
14 + | --- | --- |
15 + | Write and organize articles | [Writing content](./writing-content.en.md) |
16 + | Customize the site UI with HonoX | [Customizing your site](./customizing-your-site.en.md) |
17 + | Build a homepage and browse routes | [Discovery recipes](./discovery-recipes.en.md) |
18 + | Publish an Obsidian vault | [Obsidian](./obsidian.en.md) |
19 + | Keep content and the site in separate repositories | [Content repositories](./content-repositories.en.md) |
20 + | Build a multilingual site | [Localization](./localization.en.md) |
21 + | Collect page views | [Analytics](./analytics.en.md) |
22 + | Replace the icon, logo, or link preview image | [Branding your site](./branding.en.md) |
23 + | Deploy | [Deployment](./deployment/README.en.md) |
24 + | Upgrade Riebeckite or read migration notes | [Upgrading](./upgrading.en.md) |
25 +
26 + ## Deployment guides
27 +
28 + Deployment has its own section because the choices multiply once automation is involved.
29 +
30 + | I want to… | Guide |
31 + | --- | --- |
32 + | Deploy to Cloudflare Workers | [Cloudflare Workers](./deployment/cloudflare-workers.en.md) |
33 + | Understand the generated GitHub Actions workflow | [GitHub Actions](./deployment/github-actions.en.md) |
34 + | Read articles from a separate repository in CI | [Separate content repository](./deployment/separate-content-repository.en.md) |
35 +
36 + ## Where to look next
37 +
38 + - The **exact** configuration fields, CLI commands, and API contracts live in [Reference](../reference/README.en.md).
39 + - How the content, plugin, and theme systems are built lives in [Framework](../framework/README.en.md).
40 +