You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
}
}
The text was updated successfully, but these errors were encountered:
Improvements in the pipeline engine have made progress toward this feature. A new keyword may not need to be introduced. Using an options delegate hook may offer a better approach.
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:
The text was updated successfully, but these errors were encountered: