Skip to content

Rocq

module Rocq
Assembly Nacara.Plugin.Rocq
Attributes [<RequireQualifiedAccess>]

Documentation pages from a compiled Rocq project: a page per module, and the Guarantees page.

Functions and values

collection (name: string) (options: RocqOptions) : Collection<RocqPage>

A collection whose pages are the project's modules and its Guarantees page.

Load problems are the diagnostics rocq/project-load-failed and rocq/facts-stale. A build never runs Rocq.

Parameter
name What the site calls the collection.
options Which project to read, and where to publish it. 
config (value: string option) (options: RocqOptions) : RocqOptions

Set Config.

Parameter
value The value to use.
options The options so far. 
create (options: RocqOptions) : IPlugin

The plugin itself: the page format, assets, data files, colouring for rocq and coq fences, and rocq-capture. The collection produces the pages.

Parameter
options The same options the collection was given. 
defaults: RocqOptions

A project at _CoqProject published at the site root, with no facts or configuration.

dropStaleFacts (value: bool) (options: RocqOptions) : RocqOptions

Set DropStaleFacts.

Parameter
value The value to use.
options The options so far. 
extensions (value: IMarkdownExtension list) (options: RocqOptions) : RocqOptions

Set Extensions.

Parameter
value The value to use.
options The options so far. 
facts (value: string option) (options: RocqOptions) : RocqOptions

Set Facts.

Parameter
value The value to use.
options The options so far. 
home (value: (string * string) option) (options: RocqOptions) : RocqOptions

Set Home.

Parameter
value The value to use.
options The options so far. 
project (value: string) (options: RocqOptions) : RocqOptions

Set Project.

Parameter
value The value to use.
options The options so far. 
reader (options: RocqOptions) (context: PageContext<RocqPage>) : ReactElement

The Reader layout: modules, article and outline, with the client islands. It renders the whole document.

Parameter
options The same options the collection was given.
context The page being rendered. 
register (options: RocqOptions) (site: Site) : Site

Adds the plugin to a site.

Parameter
options The same options the collection was given.
site The site being described. 
root (value: string) (options: RocqOptions) : RocqOptions

Set Root.

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