Write Beautiful Docs
Write Beautiful Docs is the hands-on tutorial companion to the OINK reference. While the reference documents every parameter and component, this book walks through one Starter site from its first local preview to a reviewed, published bilingual site.
How to read this book
Start with Chapter 1: Start with a working site. Each chapter builds on the same Starter checkout: previewing locally, adding bilingual pages, composing clear prose and components, shaping the site’s brand and home page, choosing publishing layouts, and verifying the production build before shipping. The object indexes below also demonstrate Book publishing features; use them to locate any figure, table, equation, or code example in the book.
Contents
Figures
Tables
- Table 2-1 — One explicit order is reused by navigation, paging, and generated contents.
- Table 6-1 — Four verification stages from local preview to live deployment, and what each stage leaves to the next step.
- Table A-1 — One source tree can expose several purpose-specific Book outputs.
Equations
Examples
Install the prerequisite tools, run a local preview, and establish a visible baseline before changing the design.
Turn directories, section indexes, page bundles, and weights into one predictable reading and navigation order.
Combine prose, callouts, code, media, tables, and mathematics without turning the page into a component catalogue.
Turn a sound content structure into a recognizable, responsive, and bilingual publication.
Use Docs, Blog, Case, Book, and release pages as distinct answers to distinct reader needs.
Verify local previews, production builds, theme upgrades, and live deployments with a repeatable release checklist.
Copy-and-adapt contracts for Book roots, chapters, immersive Blog posts, and generated Book outputs.