Skip to content

RocqOptions

type RocqOptions =
    {
        Project: string
        Root: string
        Facts: string option
        Config: string option
        DropStaleFacts: bool
        Home: (string * string) option
        Extensions: IMarkdownExtension list
    }
Assembly Nacara.Plugin.Rocq

Options of the Rocq plugin.

Fields

Project: string

The _CoqProject file, relative to the project root or absolute.

Root: string

The route prefix of the pages. Empty places them at the site root.

Facts: string option

The facts.json file. None builds with source headers and no badges.

Config: string option

The navigator.json file. None leaves every setting absent.

DropStaleFacts: bool

Drops the facts of a file whose digest changed, rather than failing with rocq/facts-stale.

Home: (string * string) option

A link back to the host site: its label and URL.

Extensions: IMarkdownExtension list

The Markdig extensions applied to comments. Raw HTML stays disabled.