# Design navigation for an offline HTML handbook

Canonical: https://githtml.com/guides/design-offline-document-navigation
Published: 2026-09-26
Publisher: WaveTech LLC / gitHtml

Build offline navigation around content that is actually present: an in-document contents list, stable section anchors, and clearly labeled external references. Links to other files require those files to be available and resolvable in the destination reader. A website-style menu alone does not prove that an exported handbook can be traversed offline.

## Choose the packet boundary

Decide whether the reading unit is one HTML document or a collection of files. A single handbook can use fragment links to its own sections, reducing uncertainty about neighboring pages. A collection needs an explicit inventory and a tested relationship between its files.

Keep the boundary small enough to inspect. If an overview links into dozens of reference pages, identify the subset essential to the reader’s task and label the rest as additional online material.

## Make destinations descriptive

Use link text that explains where the reader will go, such as configuration prerequisites or retry error reference. Avoid repeated labels like click here that lose meaning when scanned. Give section headings stable identifiers in your authoring system.

A simple contents list should reflect the task sequence rather than reproduce every heading indiscriminately. Place prerequisite and safety sections before operational steps, and include an easy route back to the contents in long documents.

1. Define whether the packet is one file or a verified collection.
2. Add descriptive contents links and stable section destinations.
3. Follow the primary route offline without a search service.

## Distinguish internal and external routes

Mark remote references as requiring connectivity when their absence would otherwise surprise the reader. Explain their role in the sentence around the link. If the reference contains a prerequisite, summarize the necessary information locally instead of making the reader leave the packet.

For file-to-file links, verify the relative paths after export. Moving a document into another directory changes the context for those references. A link that worked in the generator’s preview may not work in a standalone reading copy.

## Walk the route without search

Turn off connectivity and follow the main task using only the packet’s visible navigation. Test the contents, back links, section destinations, and any linked chapter. Do not rely on a remote search box to compensate for a missing index.

In gitHtml, confirm each required HTML document and actual link behavior rather than assuming website mirroring. Record broken or remote-only destinations and either fix the packaging or make the limitation explicit before distributing the handbook.

## Sources and further reading

- [MDN: HTML anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/a)

## Related guides

- [Run an offline documentation preflight before travel](https://githtml.com/guides/offline-document-reading-preflight)
- [Inventory an HTML document’s offline dependencies](https://githtml.com/guides/inventory-offline-html-dependencies)
- [Use inline CSS for a dependable portable reading copy](https://githtml.com/guides/use-inline-css-for-portable-html)
- [Prepare diagrams that remain useful offline](https://githtml.com/guides/prepare-diagrams-for-offline-documentation)

Editorial approach: https://githtml.com/guides/about