Struct DocusaurusGlossaryOptions

pub struct DocusaurusGlossaryOptions { /* private fields */ }

Implementations

impl DocusaurusGlossaryOptions

pub fn with_slug(self, slug: &str) -> Self

Format the slug in the metadata section of the generated MDX document.

By default the root /glossary path is used.

pub fn generate(self, module: &Documentation) -> Result<String, RenderError>

Build MDX documentation for docusaurus from the given module documentation struct, with a glossary that group all functions from all submodules.

Return

A glossary and a hashmap with the name of the module as the key and its raw documentation as the value.

Errors

Handlebar failed to render the variables in the module documentation.

Trait Implementations

impl Default for DocusaurusGlossaryOptions

fn default() -> DocusaurusGlossaryOptions

Returns the “default value” for a type.