18 PRACTICAL GUIDES
Understand documentation generators, HTML exports, and portable reading copies. Local build recipes with clear limits and verification steps.
Documentation source and documentation output serve different jobs. Markdown is convenient to edit; HTML can provide a complete reading page; a hosted documentation site may add search or routing that needs a server. Use these guides to choose an output deliberately, run the build locally, and check which dependencies travel with the result.
Documentation builds and formats · 2 min
Create a complete HTML reading document from Markdown locally, then verify structure, metadata, and resource dependencies.
Read guide : Convert Markdown to standalone HTML with PandocDocumentation builds and formats · 2 min
Use Pandoc’s resource embedding option while checking external requests, dynamic content, and the limits of a self-contained export.
Read guide : Embed resources in a Pandoc HTML export carefullyDocumentation builds and formats · 2 min
Build an ordered single-file handbook with Pandoc while checking chapter boundaries, heading structure, and cross-references.
Read guide : Combine Markdown chapters into one HTML handbookDocumentation builds and formats · 2 min
Record conversion settings beside the source so future local HTML exports use a consistent format, resource policy, and output path.
Read guide : Make Pandoc HTML exports repeatable with a defaults fileDocumentation builds and formats · 2 min
Generate and inspect an existing MkDocs project locally while keeping source files, build output, and publication separate.
Read guide : Build MkDocs HTML locally before sharing itDocumentation builds and formats · 2 min
Understand directory-style URLs, direct HTML filenames, and why a MkDocs file export still needs dependency checks.
Read guide : Configure MkDocs links for file-oriented readingDocumentation builds and formats · 2 min
Generate an existing Sphinx project’s HTML output locally and inspect warnings, cross-references, and reader-facing structure.
Read guide : Build Sphinx HTML for a local documentation reviewDocumentation builds and formats · 2 min
Combine a Sphinx document tree into a long HTML page while checking supporting assets and navigation before offline use.
Read guide : Use Sphinx singlehtml without assuming a self-contained fileDocumentation builds and formats · 2 min
Inspect an existing Docusaurus production build locally without confusing generated static files with publication or a single-file export.
Read guide : Build Docusaurus for a local documentation reviewDocumentation builds and formats · 2 min
Diagnose root-relative asset and route assumptions when a Docusaurus site moves under a subpath or into a reading workflow.
Read guide : Review Docusaurus base paths before exporting documentationDocumentation builds and formats · 2 min
Build a focused TypeScript API reference locally and verify that the output describes the interface your readers actually use.
Read guide : Generate TypeDoc HTML from a public entry pointDocumentation builds and formats · 2 min
Use explicit entry points and review inclusion rules so generated API documentation does not expose an accidental implementation surface.
Read guide : Control TypeDoc scope before sharing an API referenceDocumentation builds and formats · 2 min
Build documentation for an existing Swift package with the configured DocC plugin and understand what the resulting archive contains.
Read guide : Generate a Swift DocC archive locallyDocumentation builds and formats · 2 min
Understand why a statically hosted DocC archive can still use an application runtime and needs separate offline-reader verification.
Read guide : Distinguish DocC static hosting from portable HTMLDocumentation builds and formats · 2 min
Choose a maintainable policy for generated HTML artifacts without confusing repository presence with publication or source authority.
Read guide : Version documentation source and generated output deliberatelyDocumentation builds and formats · 2 min
List document paths, revisions, dependencies, and verification status so a released reading packet can be checked and refreshed.
Read guide : Create a manifest for a documentation release packetDocumentation builds and formats · 3 min
Match a focused handbook, structured site, or generated API reference to an appropriate local build workflow and output check.
Read guide : Choose a documentation export tool by the reading taskDocumentation builds and formats · 3 min
Understand the separate roles of building, serving locally, publishing, and reading saved HTML before sharing a documentation result.
Read guide : Distinguish local documentation preview from hosting