PSDocs is able to generate markdown based on objects. When building documentation sites it is often additionally required to generate a table of contents (TOC) in markdown or yaml for processing by a publishing tool chain.
Currently the Get-PSDocumentHeader cmdlet can be used to extract yaml front matter from markdown and build a TOC however a more integrated solution would be preferred.
Potentially something like:
document 'Sample' {
Section 'Header 1' {
'Section text'
}
Index {
# An indexing action
}
}
PSDocs is able to generate markdown based on objects. When building documentation sites it is often additionally required to generate a table of contents (TOC) in markdown or yaml for processing by a publishing tool chain.
Currently the
Get-PSDocumentHeadercmdlet can be used to extract yaml front matter from markdown and build a TOC however a more integrated solution would be preferred.Potentially something like: