NG Essentials
Open in ChatGPTOpen in Claude

API reference

Generated from the source. Every export, grouped by kind.

Functions

  • contentPages - Content pages (an href plus a renderer) of a navigation tree, depth-first.
  • docsAssetStateKey - Transfer-state key of a docs asset, shared by the browser and server implementations.
  • docsFromManifest - Declares a documentation site loaded at runtime from a build-time manifest.
  • extractManifestSources - Collects manifest sources from route data (mirrors extractNgeDocSettings).
  • extractNgeDocSettings
  • flattenPages - Routable links of a manifest in reading order (depth-first, a parent before
  • indexablePages - Every routable page across the manifests, with its breadcrumb path (site name first).
  • isNgeDocManifestSource - Type guard for a NgeDocManifestSource.
  • isNgeDocSettings
  • joinUrl - Joins two url segments with exactly one slash between them.
  • provideNgeDoc - Configure the nge-doc engine at the application root.
  • settingsToManifest - Converts code-first NgeDocSettings into a NgeDocManifest:
  • withBrand - Set a single brand (logo and title) for the header, shared across every site.
  • withDarkMode - Set the default color scheme applied before the user picks one.
  • withEditLink - Show an "Edit this page" link built from baseUrl and each page's compiler
  • withLabels - Translate or reword the default theme. Pass only the labels you want to change.
  • withMarkdownRenderer - Register the component used to render markdown pages.
  • withNavbar - Declare the header navigation links (e.g. to move between documentation sites).
  • withSearchIndex - Search a build-time index emitted by the @cisstech/nge:docs builder instead
  • withSeo - Enable per-page canonical, Open Graph and Twitter tags. Titles and descriptions
  • withTheme - Use a custom theme instead of the default one.

Classes

Interfaces

  • NgeDocBrand - The header brand: one logo and wordmark shared by every site.
  • NgeDocFeature - A configuration feature for provideNgeDoc.
  • NgeDocHeading - A heading extracted from the rendered page, used to build a table of contents.
  • NgeDocLabels - User-facing wording of the default theme, so it can be translated or reworded.
  • NgeDocLink - Representation of a link in the documentation navigation.
  • NgeDocLinkAction
  • NgeDocManifest - A resolved documentation site: its metadata and the navigation tree with every
  • NgeDocManifestSource - A file-first source: the url of a manifest emitted by the build. Declared in a
  • NgeDocMeta - Metadata informations about a documentation site.
  • NgeDocNavLink - A top-level navigation link shown in the theme header.
  • NgeDocSearchDocument - A unit of the search index: one document per page, or per heading when content is indexed.
  • NgeDocSearchProvider - Pluggable search backend. The default builds its index in memory from the
  • NgeDocSearchResult - A page returned by a NgeDocSearchProvider for a query.
  • NgeDocSeoConfig - Site-wide SEO settings used to build canonical, Open Graph and Twitter tags.
  • NgeDocSettings - Documentation site config.
  • NgeDocState - Representation of the documentation state.

Type aliases

Variables

Edit this page