#Static Site
25 posts
Build a Manual with Docusaurus #6: Maintenance — Search, Accessibility, and Documentation Culture
The final post in the series. We'll add search properly to Docusaurus, cover the accessibility that lets everyone read your docs, and the Docs as Code culture that keeps docs alive over time, laying out the operations perspective to close out the series.
Build a Manual with MkDocs #6: Maintenance — Search, Accessibility, and Documentation Culture
The final post in the series. We'll close it out from the operations perspective: refining Material's built-in search, accessibility that lets everyone read, and the Docs as Code culture that keeps docs alive for a long time.
Build a Manual with Starlight #6: Maintenance — Search, Accessibility, Docs Culture
The final post in the series. We touch on Starlight's built-in search, accessibility that lets everyone read the docs, and the Docs as Code culture that keeps docs alive for the long run, closing the series on the operations perspective.
Comparing Documentation Site Generators — Hugo, MkDocs, Docusaurus, Starlight: Which One to Pick
Once you've decided to build your team docs as a static site, the next question is which tool to build it with. We compare Hugo, MkDocs, Docusaurus, and Starlight across runtime, search, versioning, and ceiling, and lay out which to choose for which situation.
Build a Manual with Docusaurus #5: Multilingual and Versioning
We cover serving one set of docs in multiple languages, and keeping older docs alive as the product version climbs. With both multilingual and versioning available as built-in features, this is the area where Docusaurus is strongest.
Build a Manual with Hugo #6: Maintenance — Search Index, Accessibility, Documentation Culture
The final post in the series. We close it out with the operations perspective: a Pagefind search index for docs that have grown large, accessibility so everyone can read, and a Docs as Code culture that keeps docs alive for the long run.
Build a Manual with MkDocs #5: Multilingual Docs and Versioning
We cover serving one set of docs in multiple languages and keeping older docs around as product versions move up. We'll add multilingual support with the mkdocs-static-i18n plugin, and attach version snapshots and a version selector with mike.
Build a Manual with Starlight #5: Multilingual and Versioning
We cover serving one doc in multiple languages and keeping old docs around as product versions move up. Multilingual support comes built into Starlight, and versioning is added with a plugin.
Build a Manual with Docusaurus #4: Deploy to Cloudflare Pages and Connect a Domain
We send the docs you built locally out into the world. We'll push to GitHub, connect to Cloudflare Pages and set up the Node build, and attach a custom domain. We'll also touch on Docusaurus's built-in deploy command.
Build a Manual with Hugo #5: Multilingual Content and Versioning
We cover serving one set of docs in several languages and keeping old docs around as the product version goes up. We walk through Hugo's multilingual configuration and translation linking, plus a practical, folder-based way to handle versioning, which Hugo has no built-in feature for.
Build a Manual with MkDocs #4: Deploy on Cloudflare Pages and Connect a Domain
We send the docs we built locally out into the world. We'll pin dependencies with requirements.txt, push to GitHub and connect it to Cloudflare Pages, and attach a custom domain. We'll also touch on gh-deploy, MkDocs' built-in deployment.
Build a Manual with Starlight #4: Deploy to Cloudflare Pages and Connect a Domain
We send the docs we built locally out into the world. We push to GitHub, connect Cloudflare Pages and set up the Astro build, and attach a custom domain.