PSDocs Versions Save

Generate documentation from Infrastructure as Code (IaC).

v0.4.0

5 years ago
  • Fix handling of line break for multiline table columns using a wrap separator #11
  • Added New-PSDocumentOption cmdlet to configure document generation
  • Added -Option parameter to Invoke-PSDocument cmdlet to accept configuration options
  • Important change: Renamed Yaml keyword to Metadata. Yaml keyword is still supported but deprecated, switch to using Metadata instead
  • Breaking change: Added support for encoding markdown content output #16
    • To specify the encoding use the -Encoding parameter of Invoke-PSDocument and Invoke-DscNodeDocument
    • Output now defaults to UTF-8 without byte order mark (BOM) instead of ASCII

v0.3.0

6 years ago
  • Improved Yaml block handling to allow yaml header to be defined throughout the document and merged when multiple blocks are defined
  • Improved cmdlet help
  • Output path is automatically created by Invoke-PSDocument if it doesn't exist
  • Fix to improve handling when Title block is used multiple times
  • Fix to prevent yaml header being created when Yaml block is not used
  • Code blocks now generate fenced sections instead of indented sections
  • Breaking change The body of Code blocks are now no longer evaluated as an expression
    • This change improves editing of document templates, allowing editors to complete valid PowerShell syntax
    • Define an expression and the pipe the results to the Code keyword to dynamically generate the contents of a code block
  • Breaking change -ConfigurationData parameter of Invoke-PSDocument has been removed while purpose and future use of the parameter is reconsidered

v0.2.0

6 years ago
  • Added Desired State Configuration (DSC) extension module PSDocs.Dsc to generate markdown from DSC .mof files