Options
All
  • Public
  • Public/Protected
  • All
Menu

Module app

App module used in node.js env.

Index

References

Functions

References

map

Renames and exports default

Functions

addMetaNavigation

  • addMetaNavigation(documents: Document[], metadata: DocumentMetadata[], filenames: string[]): void

  • Adds meta navigation links e.g. to next/prev, license, manifest, homepage to the of documents.

    Parameters

    • documents: Document[]
    • metadata: DocumentMetadata[]

      Document metadata used for meta navigation links

    • filenames: string[]

    Returns void

    Mutates documents by adding and appending navigation links to <head> HTML element.

composeManifest

default

  • default(content: string[], filenames: string[], conf: Config, revision: Revision): MappedPublication

  • Maps HTML for next-book use.

    Parameters

    • content: string[]

      Array of file contents

    • filenames: string[]

      Names of files form which content was read

    • conf: Config
    • revision: Revision

      Revision identifier string

    Returns MappedPublication

    Array of mapped documents in specified format

Generated using TypeDoc