Renders an MkDocs-compatible markdown document out of sen type sets. Stateful (caches the loaded inja templates), so prefer reusing one instance across calls when possible. More...

#include <mkdocs.h>

Public Member Functions
	MkDocsGenerator ()
	~MkDocsGenerator ()
std::string	generate (const sen::lang::TypeSetContext &typeSets, const std::string &title)
	Renders a single markdown document covering every type set in the supplied context. title becomes the document title used in the rendered file's heading.

Detailed Description

Renders an MkDocs-compatible markdown document out of sen type sets. Stateful (caches the loaded inja templates), so prefer reusing one instance across calls when possible.

Constructor & Destructor Documentation

◆ MkDocsGenerator()

sen::gen::MkDocsGenerator::MkDocsGenerator ( )

◆ ~MkDocsGenerator()

sen::gen::MkDocsGenerator::~MkDocsGenerator ( )

Member Function Documentation

◆ generate()

std::string sen::gen::MkDocsGenerator::generate	(	const sen::lang::TypeSetContext &	typeSets,
		const std::string &	title )

nodiscard

Renders a single markdown document covering every type set in the supplied context. title becomes the document title used in the rendered file's heading.

The documentation for this class was generated from the following file:

mkdocs.h