Class NavGenerator

java.lang.Object

ai.redouble.docs.NavGenerator

public class NavGenerator
extends Object

Generates the sidebar navigation shared by every page of the documentation site, from the contents: the front matter at the top, then one numbered, collapsible section per part, its pages in reading order and a nested item under the item it nests under in CONTENTS.md. Beside the name at its top sits the version the site documents, as a badge. A site that is published beside other versions has the badge name the list of them, and page JavaScript turns it into a choice among those versions; a site that stands alone, like the copy inside the demo, names no list and keeps the plain badge. The nav carries no per-page "active" marker; page JavaScript highlights the link matching location.pathname at load time and expands its part.

Since:

0.1 (2026-09-17)

Author:

Andrey Santrosyan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VERSIONS_LIST	The address, relative to a page, of the list of versions a published site sits beside.

Constructor Summary

Constructors

Constructor	Description
NavGenerator()

Method Summary

Modifier and Type	Method	Description
static String	generate(Contents contents, Map<Path, GenerateDocs.Page> pages, String version, boolean versionsBeside)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VERSIONS_LIST

public static final String VERSIONS_LIST

The address, relative to a page, of the list of versions a published site sits beside.

See Also:

• Constant Field Values

Constructor Details

NavGenerator

public NavGenerator()

Method Details

generate

public static String generate(Contents contents,
 Map<Path, GenerateDocs.Page> pages,
 String version,
 boolean versionsBeside)