Static Property Documentation

• allowLeadingSlashInLinks: Boolean

  Allow links to contain a leading "/".

  For example:

  [/doc/foo.md]()

  Is equivalent to:

  [doc/foo.md]()

  Defaults to: true

• discardFileExtension: Boolean

  Whether the source file extension (like .md) should be omitted from the name and URL. Note that even when this is true, links to filepaths will still be functional.

  Defaults to: true

• discardIdPrefix: RegExp

  A pattern for adjusting the names of documents. Useful if there is a common leading or trailing string you do not want to end up showing in the URL.

• exclude: Array.<String>

  Patterns to exclude files that were matched by @source.

  Defaults to: []

• fullFolderTitleDelimiter: String

  When displaying full-folder titles, this is the symbol that will separate folders apart.

  For example, for a folder at docs/support/tier1, the title would be:

  Docs - Support - Tier1

  Defaults to: " - "

• fullFolderTitles: Boolean

  Turning this on will make the listing (sidebar or document index) use the full path for folders, as opposed to their name.

  You should turn this on if your documents are nested within folders that could get more than one level deep.

  Defaults to: true

• generateMissingHeadings: Boolean

  Should a document not have a primary heading (# Heading, or <h1 />) then we will try to generate a heading for it using the file name (a human-friendly version of it, that is.)

  Defaults to: true

• id: String

  A unique identifier for the plugin. This identifier will also be used as a baseURL unless you specify it.

  Defaults to: "articles"

• sanitize: Boolean

  Defaults to: true

• source: Array.<String>

  Patterns to locate the source files.

  Defaults to: [ "doc/**/*.md" ]

• title: String

  The title is displayed in certain contexts like the Spotlight. It should be descriptive but very brief.

  Defaults to: "Articles"