Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SetupWikiOptions

Options for 'setupWikiUI()' function.

Hierarchy

  • SetupWikiOptions

Index

Properties

Properties

Optional basePath

basePath: string

The custom base path.

Optional css

css: string | function

The path to additional CSS style or the function that provides it.

Optional favIcon

favIcon: string | function

The path to the FavIcon or the function that provides it.

Optional js

js: string | function

The path to additional JavaScript code or the function that provides it.

Optional logo

logo: string | function

The path to the page logo or a function that provides it.

Optional root

root: string

The custom root endpoint (name). Default: '/wiki'

Optional source

source: string

The custom current source directory. Default: '{PROCESS}/controllers'

Optional subTitle

subTitle: function

The function that generates the sub title.

returns

The value for the subtitle.

Type declaration

    • (file: string): any

    • Parameters

      • file: string

      Returns any

Optional syntaxTheme

syntaxTheme: string | function

Name of the highlight.js CSS theme or the function, that provides it. Default: 'mono-blue'

Optional title

title: string

The page title.

Generated using TypeDoc