Header menu logo FSharp.Formatting

ParamKeys Module

  Defines the parameter keys known to FSharp.Formatting processing code

Functions and values

Function or value Description

ParamKeys.``fsdocs-authors``

Full Usage: ParamKeys.``fsdocs-authors``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-body-class``

Full Usage: ParamKeys.``fsdocs-body-class``

Returns: ParamKey

A parameter key known to FSharp.Formatting, either 'content' or 'api-doc' Mean to be used on the `class` attribute in the `` tag. This helps to differentiate styles between API docs and custom content.

Returns: ParamKey

ParamKeys.``fsdocs-body-extra``

Full Usage: ParamKeys.``fsdocs-body-extra``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available when `_head.html` exists in the input folder.

Returns: ParamKey

ParamKeys.``fsdocs-collection-name-link``

Full Usage: ParamKeys.``fsdocs-collection-name-link``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-collection-name``

Full Usage: ParamKeys.``fsdocs-collection-name``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-content``

Full Usage: ParamKeys.``fsdocs-content``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-copyright``

Full Usage: ParamKeys.``fsdocs-copyright``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-favicon-src``

Full Usage: ParamKeys.``fsdocs-favicon-src``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-head-extra``

Full Usage: ParamKeys.``fsdocs-head-extra``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available when `_head.html` exists in the input folder.

Returns: ParamKey

ParamKeys.``fsdocs-license-link``

Full Usage: ParamKeys.``fsdocs-license-link``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-list-of-documents``

Full Usage: ParamKeys.``fsdocs-list-of-documents``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-list-of-namespaces``

Full Usage: ParamKeys.``fsdocs-list-of-namespaces``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-logo-link``

Full Usage: ParamKeys.``fsdocs-logo-link``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-logo-src``

Full Usage: ParamKeys.``fsdocs-logo-src``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-menu-header-active-class``

Full Usage: ParamKeys.``fsdocs-menu-header-active-class``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available in _menu_template.html This will be an empty string if the category is not active.

Returns: ParamKey

ParamKeys.``fsdocs-menu-header-content``

Full Usage: ParamKeys.``fsdocs-menu-header-content``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available in _menu_template.html

Returns: ParamKey

ParamKeys.``fsdocs-menu-header-id``

Full Usage: ParamKeys.``fsdocs-menu-header-id``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available in _menu_template.html

Returns: ParamKey

ParamKeys.``fsdocs-menu-item-active-class``

Full Usage: ParamKeys.``fsdocs-menu-item-active-class``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available in _menu-item_template.html /// This will be an empty string if the item is not active.

Returns: ParamKey

ParamKeys.``fsdocs-menu-item-content``

Full Usage: ParamKeys.``fsdocs-menu-item-content``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available in _menu-item_template.html

Returns: ParamKey

ParamKeys.``fsdocs-menu-item-id``

Full Usage: ParamKeys.``fsdocs-menu-item-id``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available in _menu-item_template.html

Returns: ParamKey

ParamKeys.``fsdocs-menu-item-link``

Full Usage: ParamKeys.``fsdocs-menu-item-link``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available in _menu-item_template.html

Returns: ParamKey

ParamKeys.``fsdocs-menu-items``

Full Usage: ParamKeys.``fsdocs-menu-items``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available in _menu_template.html

Returns: ParamKey

ParamKeys.``fsdocs-next-page-link``

Full Usage: ParamKeys.``fsdocs-next-page-link``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available when frontmatter is used correctly

Returns: ParamKey

ParamKeys.``fsdocs-package-icon-url``

Full Usage: ParamKeys.``fsdocs-package-icon-url``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-package-license-expression``

Full Usage: ParamKeys.``fsdocs-package-license-expression``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-package-project-url``

Full Usage: ParamKeys.``fsdocs-package-project-url``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-package-tags``

Full Usage: ParamKeys.``fsdocs-package-tags``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-package-version``

Full Usage: ParamKeys.``fsdocs-package-version``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-page-content-list``

Full Usage: ParamKeys.``fsdocs-page-content-list``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-page-source``

Full Usage: ParamKeys.``fsdocs-page-source``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-page-title``

Full Usage: ParamKeys.``fsdocs-page-title``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-previous-page-link``

Full Usage: ParamKeys.``fsdocs-previous-page-link``

Returns: ParamKey

A parameter key known to FSharp.Formatting, available when frontmatter is used correctly

Returns: ParamKey

ParamKeys.``fsdocs-release-notes-link``

Full Usage: ParamKeys.``fsdocs-release-notes-link``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-repository-branch``

Full Usage: ParamKeys.``fsdocs-repository-branch``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-repository-commit``

Full Usage: ParamKeys.``fsdocs-repository-commit``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-repository-link``

Full Usage: ParamKeys.``fsdocs-repository-link``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-source-basename``

Full Usage: ParamKeys.``fsdocs-source-basename``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-source-filename``

Full Usage: ParamKeys.``fsdocs-source-filename``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-source``

Full Usage: ParamKeys.``fsdocs-source``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-theme``

Full Usage: ParamKeys.``fsdocs-theme``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-tooltips``

Full Usage: ParamKeys.``fsdocs-tooltips``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.``fsdocs-watch-script``

Full Usage: ParamKeys.``fsdocs-watch-script``

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

ParamKeys.root

Full Usage: ParamKeys.root

Returns: ParamKey

A parameter key known to FSharp.Formatting

Returns: ParamKey

Type something to start searching.