Package ai.redouble.docs
package ai.redouble.docs
-
ClassDescriptionThe site's reading order, parsed from
nucleo-docs/CONTENTS.md: the one place that says which documents the site carries, what each is called, and in which order a reader meets them.Generates the HTML documentation site from the markdown files in the reactor's source trees.One page of the site: its id (the file name without .html), its title from the contents, its markdown source, the part it belongs to as the breadcrumb reads it (null for the front matter) and the package and module the source documents (null for a document outside every module's source tree).Rewrites links in a page's markdown before conversion.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 inCONTENTS.md.Puts the generated site into a checkout of the documentation repository as one version of the published documentation.Checks that the code a page shows is the code that compiles.What the site's search box searches: one entry per place a reader can land on, written as the page assetsearch-index.js.One place a search lands on: the address relative to the site's root, the title of the page or the name of the class, the part of the contents the page belongs to (null for the front matter), the heading of the section (null for a page's opening and for a class) and the text searched.