MDFlatten
Documenter.MDFlatten
— ModuleProvides the mdflatten
function that can "flatten" Markdown objects into a string, with formatting etc. stripped.
Note that the tests in test/mdflatten.jl
should be considered to be the spec for the output (number of newlines, indents, formatting, etc.).
Documenter.MDFlatten.mdflatten
— MethodConvert a Markdown object to a String
of only text (i.e. not formatting info).
It drop most of the extra information (e.g. language of a code block, URLs) and formatting (e.g. emphasis, headers). This "flattened" representation can then be used as input for search engines.