Quickstart

Goals

• Run locally: preview while editing
• Publish on GitHub: host the static site using GitHub Pages

Directory layout (example)

.
├─ book.toml
├─ src/
│  ├─ zh/
│  │  ├─ SUMMARY.md
│  │  ├─ README.md
│  │  ├─ guide/
│  │  ├─ hahaha/
│  │  ├─ design/
│  │  ├─ adr/
│  │  ├─ discussions/
│  │  └─ appendix/
│  └─ en/
│     ├─ SUMMARY.md
│     ├─ README.md
│     ├─ guide/
│     ├─ hahaha/
│     ├─ design/
│     ├─ adr/
│     ├─ discussions/
│     └─ appendix/
└─ .github/workflows/deploy.yml   (optional)

Next steps

• For local preview right away: see “Local Preview”
• To keep writing style consistent: see “Writing Style”