Markdown

module Markdown


Assembly	`Nacara.Plugin.Markdown`
Attributes	`[<RequireQualifiedAccess>]`

Functions and values

create () : IPlugin

The markdown plugin, with its default options.

createWith (configure: MarkdownOptions -> MarkdownOptions) : IPlugin

The markdown plugin, configured.

Parameter
`configure`	Given the defaults, the options to use. Anything it leaves alone keeps its default.

defaults: MarkdownOptions

frontMatterFormat: FrontMatterFormat

How a markdown file carries its front matter: a block at the top of the file.

githubRepo (value: string option) (options: MarkdownOptions) : MarkdownOptions

Repository used to expand issue and commit references, for example MangelMaxime/Nacara.

Parameter
`value`	The value to use.
`options`	The options so far.

register (site: Site) : Site

Add markdown to a site.

Site.create "Docs" |> Markdown.register

registerWith (configure: MarkdownOptions -> MarkdownOptions) (site: Site) : Site

Add markdown to a site, configured.

Parameter
`configure`	Given the defaults, the options to use. Anything it leaves alone keeps its default.
`site`	The site being described.

strictLinks (value: bool) (options: MarkdownOptions) : MarkdownOptions

Fail the build on a link that points at no page.

Parameter
`value`	The value to use.
`options`	The options so far.

toc (value: TocRange) (options: MarkdownOptions) : MarkdownOptions

Heading levels collected into the table of contents, for pages that do not say.

Parameter
`value`	The value to use.
`options`	The options so far.

warnOnUnknownLanguage (value: bool) (options: MarkdownOptions) : MarkdownOptions

Report a fence naming a language no highlighter covers.

Parameter
`value`	The value to use.
`options`	The options so far.