Struct DocusaurusOptions

pub struct DocusaurusOptions { /* private fields */ }

Implementations

impl DocusaurusOptions

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

Format the slug in the metadata section of the generated MDX document by concatenating the slug parameter with the module name.

For example, if the documentation for a module called my_module is generated with the slug /docs/api/, the slug set in the document will be /docs/api/my_module.

By default the root / path is used.

pub fn rename_root_module(self, name: &str) -> Self

When registering stuff into your engine, some items will be exported in the “global” module, a module that is accessible without the need to specify it’s name. For documentation sake, you can use this method to rename the global module so that you can split multiple items groups into multiple global modules without having the “global” slug everywhere.

For example, if the documentation exports items under the global namespace with the slug /docs/api/ and the module renamed as my_module, the slug set in the document will be /docs/api/my_module instead of /docs/api/global.

By default the root global module name is used.

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

Build MDX documentation for docusaurus from the given module documentation struct.

Return

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 DocusaurusOptions

fn default() -> DocusaurusOptions

Returns the “default value” for a type.