Releases: microsoft/PSDocs
Releases · microsoft/PSDocs
v0.8.0-B2101006
See change log
v0.7.0
See change log
v0.7.0-B2101015
See change log
v0.7.0-B2008035
See change log
v0.7.0-B2008022
See change log
v0.6.3
See change log
v0.6.2
See change log
v0.6.1
See change log
v0.6.0
- Fix consistency of line break generation before and after document content.
- Added
BlockQuote
keyword to generate block quotes in addition to existingNote
andWarning
keywords which are specific to DocFX- See about_PSDocs_Keywords help topic for details
- Added
-Culture
parameter toInvoke-PSDocument
, which allows generation of multiple localized output files - Added
Include
keyword to insert content from an external file- Use the
-UseCulture
switch ofInclude
to insert content from a culture specific external file - See about_PSDocs_Keywords help topic for details
- Use the
- Added support for locked down environments to ensure that documents are executed as constrained code when Device Guard is used
- Use the
Execution.LanguageMode = 'ConstrainedLanguage'
option to force constrained language mode
- Use the
- Added new contextual help topic to provide details on automatic variables exposed for PSDocs for use within document definitions
- Breaking change: Removed
Import-PSDocumentTemplate
cmdlet. UseInvoke-PSDocument
instead or dot source - Breaking change: Removed support for
-Function
parameter ofInvoke-PSDocument
. External commands can be executed in document blocks. Re-evaluating if this is really needed. - Important change: Renamed
-When
parameter on Section block to-If
.-When
is still works but is deprecated. - Important change: Improved markdown formatting for tables #31
- Table columns are now padded by default to match header width. Set
Markdown.ColumnPadding
option toNone
to match format style from PSDocs <= 0.5.0 - Pipe characters on the start and end of a table row are not added by default. Set
Markdown.UseEdgePipes
option toAlways
to match format style from PSDocs <= 0.5.0 - Property expressions now support Label, Expression, Alignment and Width keys
- Table columns are now padded by default to match header width. Set
- Important change: Added support for
Note
andWarning
keywords to accept text from the pipeline- Using the pipeline is now the preferred way to use
Note
andWarning
keywords Note
andWarning
script blocks are still work, but are deprecated.
- Using the pipeline is now the preferred way to use
- Experimental: Publishing of keywords for syntax completion with editors
v0.5.0
- Fix to prevent string builder properties being outputted each time
Invoke-PSDocument
is called - Added support for property expressions with the
Table
keyword #27 - Important change: Deprecated support for using
Invoke-PSDocument
with inline document definitions- Improved support for using named document definitions inline, this is the recommended way to call inline document definitions
- Added support for building all document definitions from a path using the
-Path
parameter #25- Additionally document definitions can be filtered with the
-Name
and-Tag
parameter - This is the recommended way to build documents going forward
- Additionally document definitions can be filtered with the
- Added support for providing options for
Invoke-PSDocument
using YAML, seeabout_PSDocs_Options
- Breaking change: Empty
Section
blocks are not rendered by default #32- Use
-Force
parameter on specific sections orMarkdown.SkipEmptySections = $False
option to force empty sections to be written
- Use