Documentarian

Style Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Reference documentation for the Vale style configuration in the PowerShell-Docs style package.

Style Rules

Mon, 01 Jan 0001 00:00:00 +0000

Reference documentation for the Vale style rules in the PowerShell-Docs style package.

Mon, 01 Jan 0001 00:00:00 +0000

Private Source

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.DevX.Private.psm1 file.

[Classes]
[Enums]
[Functions]

Classes

This folder contains the private classes used by this module and their unit tests.

The .LoadOrder.jsonc file determines the order the classes should be loaded during composition; this is critical to ensure nothing breaks.

Mon, 01 Jan 0001 00:00:00 +0000

Public Source

This folder contains the public classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.DevX.psm1 file.

[Classes]
[Enums]
[Functions]
- [Completion]
- [Configuration]
- [General]

Classes

This folder contains the public classes used by this module and their unit tests. During composition, these classes are also included in the generated Init.ps1 file, which enables automatic import of the public classes into the caller’s session for direct use.

Mon, 01 Jan 0001 00:00:00 +0000

Source

The files and folders here contain the content that is pulled together for publishing to the PowerShell Gallery. Information on the files and folders are included below.

Private

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.DevX.Private.psm1 file.

Mon, 01 Jan 0001 00:00:00 +0000

[[Name]]

Requirements

PowerShell 7.2+

Mon, 01 Jan 0001 00:00:00 +0000

Private Source

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated [[Name]].Private.psm1 file.

[Classes]
[Enums]
[Functions]

Classes

This folder contains the private classes used by this module and their unit tests.

The .LoadOrder.jsonc file determines the order the classes should be loaded during composition; this is critical to ensure nothing breaks.

Mon, 01 Jan 0001 00:00:00 +0000

Public Source

This folder contains the public classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated [[Name]].psm1 file.

[Classes]
[Enums]
[Functions]
- [Completion]
- [Configuration]
- [General]

Classes

Mon, 01 Jan 0001 00:00:00 +0000

Source

The files and folders here contain the content that is pulled together for publishing to the PowerShell Gallery. Information on the files and folders are included below.

Private

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated [[Name]].Private.psm1 file.

Mon, 01 Jan 0001 00:00:00 +0000

Templates

This folder contains the templated files and folders this module provides for users. It is copied alongside the generated module manifest, root module, private module, and init script during composition.

Mon, 01 Jan 0001 00:00:00 +0000

Templates

Module

Use the Module template folder to create a new Documentarian module with the Copy-Template cmdlet. It scaffolds the files and folders for the new module’s documentation and source code as well as a build script, changelog, and readme file.

Mon, 01 Jan 0001 00:00:00 +0000

Private Source

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.Private.psm1 file.

[Classes]
[Enums]
[Functions]

Classes

This folder contains the private classes used by this module and their unit tests.

The .LoadOrder.jsonc file determines the order the classes should be loaded during composition; this is critical to ensure nothing breaks.

Mon, 01 Jan 0001 00:00:00 +0000

Public Source

This folder contains the public classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.psm1 file.

[Classes]
[Enums]
[Functions]
- [Completion]
- [Configuration]
- [General]

Classes

Mon, 01 Jan 0001 00:00:00 +0000

Source

The files and folders here contain the content that is pulled together for publishing to the PowerShell Gallery. Information on the files and folders are included below.

Private

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.Private.psm1 file.

Mon, 01 Jan 0001 00:00:00 +0000

Private Source

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.MarkdownBuilder.Private.psm1 file.

[Classes]
[Enums]
[Functions]

Classes

This folder contains the private classes used by this module and their unit tests.

The .LoadOrder.jsonc file determines the order the classes should be loaded during composition; this is critical to ensure nothing breaks.

Mon, 01 Jan 0001 00:00:00 +0000

Public Source

This folder contains the public classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.MarkdownBuilder.psm1 file.

[Classes]
[Enums]
[Functions]
- [Completion]
- [Configuration]
- [General]

Classes

Mon, 01 Jan 0001 00:00:00 +0000

Source

The files and folders here contain the content that’s pulled together for publishing to the PowerShell Gallery. Information on the files and folders are included below.

Private

This folder has the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.MarkdownBuilder.Private.psm1 file.

For more information, see the folder’s readme.

Mon, 01 Jan 0001 00:00:00 +0000

Private Source

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.MicrosoftDocs.Private.psm1 file.

[Classes]
[Enums]
[Functions]

Classes

This folder contains the private classes used by this module and their unit tests.

The .LoadOrder.jsonc file determines the order the classes should be loaded during composition; this is critical to ensure nothing breaks.

Mon, 01 Jan 0001 00:00:00 +0000

Public Source

This folder contains the public classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.MicrosoftDocs.psm1 file.

[Classes]
[Enums]
[Functions]
- [Completion]
- [Configuration]
- [General]

Classes

Mon, 01 Jan 0001 00:00:00 +0000

Source

The files and folders here contain the content that is pulled together for publishing to the PowerShell Gallery. Information on the files and folders are included below.

Private

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.MicrosoftDocs.Private.psm1 file.

Mon, 01 Jan 0001 00:00:00 +0000

Templates

Mon, 01 Jan 0001 00:00:00 +0000

Private Source

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.ModuleAuthor.Private.psm1 file.

[Classes]
[Enums]
[Functions]

Classes

This folder contains the private classes used by this module and their unit tests.

The .LoadOrder.jsonc file determines the order the classes should be loaded during composition; this is critical to ensure nothing breaks.

Mon, 01 Jan 0001 00:00:00 +0000

Public Source

This folder contains the public classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.ModuleAuthor.psm1 file.

[Classes]
[Enums]
[Functions]
- [Completion]
- [Configuration]
- [General]

Classes

Mon, 01 Jan 0001 00:00:00 +0000

Source

The files and folders here contain the content that is pulled together for publishing to the PowerShell Gallery. Information on the files and folders are included below.

Private

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.ModuleAuthor.Private.psm1 file.

Mon, 01 Jan 0001 00:00:00 +0000

Templates

Mon, 01 Jan 0001 00:00:00 +0000

Private Source

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.Vale.Private.psm1 file.

[Classes]
[Enums]
[Functions]

Classes

This folder contains the private classes used by this module and their unit tests.

The .LoadOrder.jsonc file determines the order the classes should be loaded during composition; this is critical to ensure nothing breaks.

Mon, 01 Jan 0001 00:00:00 +0000

Public Source

This folder contains the public classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.Vale.psm1 file.

[Classes]
[Enums]
[Functions]
- [Completion]
- [Configuration]
- [General]

Classes

Mon, 01 Jan 0001 00:00:00 +0000

Source

The files and folders here contain the content that is pulled together for publishing to the PowerShell Gallery. Information on the files and folders are included below.

Private

This folder contains the private classes, enums, and functions used by this module as well as their unit tests.

During module composition, the code in this folder (except for the tests) is placed into the generated Documentarian.Vale.Private.psm1 file.

Mon, 01 Jan 0001 00:00:00 +0000

Templates

Mon, 01 Jan 0001 00:00:00 +0000

Export-MonikerContent

SYNOPSIS

Exports content from markdown files based on specified moniker conditions.

SYNTAX

Export-MonikerContent [-Path] <String[]> [-Moniker] <String> [[-OutputPath] <String>]
 [<CommonParameters>]

DESCRIPTION

This cmdlet processes markdown files and extracts content based on the specified moniker range. It uses comparison operators in the moniker range to determine which content to include in the output.

The command skips any files that don’t have a .md extension. The output file are written to the OutputPath location with the target moniker appended to original file name. For example, if the original file is example.md and the moniker is mvc-150, the output file is named example_mvc_150.md.

Add-FrontMatter

Mon, 01 Jan 0001 00:00:00 +0000

Add-FrontMatter

SYNOPSIS

Adds front matter to a MarkdownBuilder object.

SYNTAX

Add-FrontMatter [-FrontMatter] <Hashtable>
 [[-Format] <String>]
 [[-Builder] <MarkdownBuilder>]
 [[-LineEnding] <LineEnding>]
 [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Adds front matter to a MarkdownBuilder object from a given hashtable of key-value pairs.

If you don’t pass a MarkdownBuilder object to this function, it creates one. If you specify the LineEnding parameter but not the Builder parameter, the value you specified is used as the default line ending for the new object.

Add-Heading

Mon, 01 Jan 0001 00:00:00 +0000

Add-Heading

SYNOPSIS

Adds a heading to a MarkdownBuilder object.

SYNTAX

Add-Heading [-Content] <String>
 [[-Level] <Int32>]
 [[-Builder] <MarkdownBuilder>]
 [[-LineEnding] <LineEnding>]
 [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Adds an ATX style heading to a MarkdownBuilder object. If you don’t specify the Level parameter, it adds an H2 by default.

Add-Line

Mon, 01 Jan 0001 00:00:00 +0000

Add-Line

SYNOPSIS

Adds a line of content to a MarkdownBuilder object.

SYNTAX

Add-Line [[-Content] <String>]
 [[-Builder] <MarkdownBuilder>]
 [[-LineEnding] <LineEnding>]
 [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Adds a line of arbitrary content to a MarkdownBuilder object.

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

Unreleased

Scaffolded initial project.

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

Unreleased

Related Links: Pull Requests

Added

Scaffolded initial project.

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

Unreleased

Removed ar-sa from [LearnLocales]::CommonLocales.
Fixed bug in Update-Metadata to properly handle retrieving and updating front matter.
Updated *-Metadata cmdlets to use Get-Document to parse the content of markdown files
Added AsJson parameter to Get-Metadata to output the results as a JSON object

Related Links: Pull Requests

Changed

Replaced dependency on the PowerShell-yaml module with YaYaml - this resolves the YamlDotNet dependency conflict that prevents the module from being used with PlatyPS. Only the dependency is changed, not the functionality.

Fixed

Convert-MDLinks - filter out matching patterns contained in code blocks.
Ensure that Convert-MDLinks correctly handles all matches found by the regex patterns.

0.0.1 - 2023-03-27

Related Links: Source at v0.0.1

Added

Initial release.

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

Unreleased

Scaffolded initial project.

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

Unreleased

Added Export-MonikerContent to extract content matching a moniker from a markdown file.

Added Get-CmdletXref to make it simpler to add links to cmdlet reference docs.

Related Links: Pull Requests

0.0.1 - 2023-03-27

Related Links: Source at v0.0.1

Added

Initial release.

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

Unreleased

Refactored module to move AST parsing logic into a separate module.
Added HelpInfoUri parameter to Test-HelpInfoUri to allow testing a specific URI
Fixed column header name in DontShowAttributeInfo.Formats.ps1xml
Added PSDefaultValueAttribute to parameters in Find-ParameterWithAttribute

Related Links: Pull Requests

Added

Refactored Invoke-Pandoc to create the header required by Get-Help to display the help metadata correctly. Also added error handling to provide better feedback when Pandoc fails.
Update Get-ParameterInfo and Find-ParameterWithAttribute to support three more parameter attributes:

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

Unreleased

Related Links: Pull Requests

Added

Changed

Replaced an implicit dependency on the powershell-yaml module with an explicit dependency on YaYaml - this resolves the YamlDotNet dependency conflict that prevents the module from being used with PlatyPS. Only the dependency is changed, not the functionality.

0.2.0 - 2023-04-26

Related Links: Source at v0.2.0; Pull Requests

Added

Extended verbose output for New-ValeConfigurationto provide information about the created configuration file and adding messaging for the configuration’s initial sync.

Fixed

Corrected the scoring for the GunningFog rule, ensuring that results for the Get-ProseReadability command are right. Before this fix, the command would sometimes return an invalid negative score.

0.1.0 - 2023-04-06

Related Links: Source at v0.1.0; Pull Requests

Changed

Renamed Install-WorkspaceVale to Install-Vale and added the Scope parameter, enabling users to install Vale to their home directory as well as the workspace. This change ensures that the other module commands are also able to use Vale when installed to your home directory, not just the PATH or workspace.
Updated the logic for discovering Vale in the workspace to recursively search up the file tree from the current working directory instead of only searching the current directory. This makes the commands available from arbitrarily deep folders when using Vale installed to the workspace.

0.0.1 - 2023-03-27

Related Links: Source at v0.0.1

Added

Initial release.

Changelog

Mon, 01 Jan 0001 00:00:00 +0000

Unreleased

Related Links: Pull Requests

Added

Scaffolded initial project.

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the DocumentLink class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the LinkKindTransformAttribute class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ParsedDocument class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the Position class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeApplicationInfo class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeConfigurationEffective class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeConfigurationFormatLanguageAssociation class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeConfigurationFormatTransform class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeConfigurationFormatTypeAssociation class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeConfigurationIgnore class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeMetricsHeadingCount class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeMetricsInfo class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeRule class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeStyle class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeViolationAction class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeViolation class

Constructors

Mon, 01 Jan 0001 00:00:00 +0000

Constructors for the ValeViolationPosition class

Convert-MDLinks

Mon, 01 Jan 0001 00:00:00 +0000

Convert-MDLinks

SYNOPSIS

Converts Markdown hyperlinks to numbered link references.

SYNTAX

Convert-MDLinks [-Path] <string[]> [-PassThru] [<CommonParameters>]

DESCRIPTION

This cmdlet finds all hyperlinks and link references in a Markdown file then replaces all links with numbered link references. The link reference definitions are added to the end of the file. Existing link reference definitions aren’t removed. You must edit the updated Markdown file to remove them. This gives you the opportunity to inspect the new link definitions to ensure accuracy.

ConvertTo-Contraction

Mon, 01 Jan 0001 00:00:00 +0000

ConvertTo-Contraction

SYNOPSIS

Converts common word pairs to contractions in a Markdown document.

SYNTAX

ConvertTo-Contraction [-Path] <String[]> [-Recurse] [<CommonParameters>]

DESCRIPTION

The Microsoft Style Guide recommends using contractions in our documentation. The cmdlet updates markdown files by replacing common word pairs with contractions. You can update multiple files by specifying a comma-separated list of paths to file or folders and include wildcards.

EXAMPLES

Example 1 - Update all files in a folder

For this example, assume you are in the root of the azure-docs-pr repository. The following command updates all the markdown files in the articles\cloud-shell folder.

Find-Ast

Mon, 01 Jan 0001 00:00:00 +0000

Find-Ast…

Find-ParameterWithAttribute

Mon, 01 Jan 0001 00:00:00 +0000

Find-ParameterWithAttribute

SYNOPSIS

Returns a list of cmdlets and parameters that have the specified attribute type.

SYNTAX

Find-ParameterWithAttribute [-AttributeKind] <ParameterAttributeKind> [[-CommandName] <String[]>]
 [-GroupBy <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This cmdlet returns a list of cmdlets and parameters that have the specified attribute type. This is useful for finding cmdlets that have experimental parameters, parameters that have validation attributes, or other specific attributes.

EXAMPLES

Example 1: Find all cmdlets with parameters that get their value from the remaining arguments

Find-ParameterWithAttribute -AttributeKind ValueFromRemaining

Cmdlet Parameter ValueFromRemainingArguments ParameterSetName
------ --------- --------------------------- ----------------
ForEach-Object RemainingScripts True ScriptBlockSet
ForEach-Object ArgumentList True PropertyAndMethodSet
Get-Command ArgumentList True __AllParameterSets
Join-Path AdditionalChildPath True __AllParameterSets
New-Module ArgumentList True __AllParameterSets
Read-Host Prompt True __AllParameterSets
Trace-Command ArgumentList True commandSet
Write-Host Object True __AllParameterSets
Write-Output InputObject True __AllParameterSets

Example 2: Find all cmdlets with parameters that get their value from the pipeline

Find-ParameterWithAttribute -AttributeKind ValueFromPipeline -CommandName Get-Process

Cmdlet Parameter Pipeline ParameterSetName
------ --------- -------- ----------------
Get-Process Name ByValue(False), ByName(True) Name, NameWithUserName
Get-Process Id ByValue(False), ByName(True) Id, IdWithUserName
Get-Process InputObject ByValue(True), ByName(False) InputObject, InputObjectWithUserName

Example 3: Find all cmdlets with parameters that support wildcards

Find-ParameterWithAttribute -AttributeKind SupportsWildcards

Cmdlet Parameter SupportsWildcards ParameterSetName
------ --------- ----------------- ----------------
ConvertTo-Contraction Path True __AllParameterSets
Find-ParameterWithAttribute CommandName True __AllParameterSets
Get-BranchStatus GitLocation True __AllParameterSets
Get-DocumentLink IncludeKind True FilterByKind
Get-DocumentLink ExcludeKind True FilterByKind
Get-DocumentLink MatchMarkdown True __AllParameterSets
Get-DocumentLink MatchText True __AllParameterSets
Get-DocumentLink MatchDestination True __AllParameterSets
Get-DocumentLink MatchReferenceID True __AllParameterSets
Get-DocumentLink NotMatchMarkdown True __AllParameterSets
Get-DocumentLink NotMatchText True __AllParameterSets
Get-DocumentLink NotMatchDestination True __AllParameterSets
Get-DocumentLink NotMatchReferenceID True __AllParameterSets
Get-Metadata Path True AsYaml, AsObject, AsHash
Get-ValeStyle Name True ByName
Remove-Metadata Path True __AllParameterSets
Set-Metadata Path True __AllParameterSets
Update-Headings Path True __AllParameterSets
Update-Metadata Path True __AllParameterSets
Update-ParameterOrder Path True __AllParameterSets

PARAMETERS

-AttributeKind

Specifies the type of attribute you want to find. Possible values are:

Get-Ast

Mon, 01 Jan 0001 00:00:00 +0000

Get-Ast…

Get-AstType

Mon, 01 Jan 0001 00:00:00 +0000

Get-AstType…

Get-CmdletXref

Mon, 01 Jan 0001 00:00:00 +0000

Get-CmdletXref

SYNOPSIS

Gets a cross-reference link for a command.

SYNTAX

Get-CmdletXref [-Name] <System.String[]> [<CommonParameters>]

DESCRIPTION

Outputs a Learn platform cross-reference hyperlink for a command in Markdown syntax. The command can be an alias, the name of a proxy command, or the name of a cmdlet published in a module. The module must be installed on the local system.

EXAMPLES

Example 1: Get a cross-reference link for some commands

Get-CmdletXref Get-Command, Get-Help

[Get-Command](xref:Microsoft.PowerShell.Core.Get-Command)
[Get-Help](xref:Microsoft.PowerShell.Core.Get-Help)

Example 2: Pipe multiple commands to Get-CmdletXref

In this example, oss and help are proxy commands for the Out-String and Get-Help cmdlets.

Get-ContentWithoutHeader

Mon, 01 Jan 0001 00:00:00 +0000

Get-ContentWithoutHeader

SYNOPSIS

Gets the content of a Markdown file without the YAML frontmatter.

SYNTAX

Get-ContentWithoutHeader [-Path] <string> [<CommonParameters>]

DESCRIPTION

The cmdlet gets the content of a Markdown file without the YAML frontmatter. This is useful when updating the metadata of the file or for passing Markdown text to another command for processing.

EXAMPLES

Example 1 - Render the Markdown file as HTML

This example passes the Markdown content to ConvertFrom-Markdown to convert it to HTML.

Get-Document

Mon, 01 Jan 0001 00:00:00 +0000

Parses a document as Markdown and returns it as a usable object.

Get-DocumentLink

Mon, 01 Jan 0001 00:00:00 +0000

Retrieves links from a Markdown document with their metadata.

Get-HtmlMetaTags

Mon, 01 Jan 0001 00:00:00 +0000

Get-HtmlMetaTags

SYNOPSIS

Gets all of the HTML <meta> elements of a web page.

SYNTAX

Get-HtmlMetaTags [-ArticleUrl] <Uri> [-ShowRequiredMetadata] [<CommonParameters>]

DESCRIPTION

Gets all the HTML <meta> elements of a web page. This can be used to see the Docs metadata in the published article.

EXAMPLES

Example 1 - Get the `ms.*` meta tags

$url = 'https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows'
Get-HtmlMetaTags $url | Select-Object ms.*

ms.author : sewhee
ms.date : 08/02/2021
ms.devlang : powershell
ms.prod : powershell
ms.technology : powershell-conceptual
ms.tgt_pltfr : windows, macos, linux
ms.topic : conceptual

Example 2 - Show only the require metadata

$url = 'https://docs.microsoft.com/powershell/scripting/install/installing-powershell-core-on-windows'
Get-HtmlMetaTags $url -ShowRequiredMetadata

title :
og:title : Installing PowerShell on Windows - PowerShell
description : Information about installing PowerShell on Windows
ms.manager :
ms.author : sewhee
author : sdwheeler
ms.service :
ms.date : 08/02/2021
ms.topic : conceptual
ms.subservice :
ms.prod : powershell
ms.technology : powershell-conceptual
ms.custom :
ROBOTS : INDEX, FOLLOW

PARAMETERS

-ArticleUrl

The URL to the Docs article you want to inspect.

Get-LocaleFreshness

Mon, 01 Jan 0001 00:00:00 +0000

Get-LocaleFreshness

SYNOPSIS

Gets the ms.date metadata information of a Docs article for every locale.

SYNTAX

Get-LocaleFreshness [-Uri] <uri> [[-Locale] <string[]>] [<CommonParameters>]

DESCRIPTION

Gets the ms.date metadata information of a Docs article for every locale. The output includes the locale information and the translation method. This is useful to see that the localization process has picked up the latest changes made to the English version of the article.

For comparison, the output of the cmdlet always includes the English version of the article.

Get-Metadata

Mon, 01 Jan 0001 00:00:00 +0000

Get-Metadata

SYNOPSIS

Get the metadata frontmatter from a Markdown file.

SYNTAX

AsHash

Get-Metadata [-Path] <string> [-Recurse] [<CommonParameters>]

AsObject

Get-Metadata [-Path] <string> -AsObject [-Recurse] [<CommonParameters>]

AsYaml

Get-Metadata [-Path] <string> -AsYaml [-Recurse] [<CommonParameters>]

AsJson

Get-Metadata [-Path] <string> -AsJson [-Recurse] [<CommonParameters>]

DESCRIPTION

Get the metadata frontmatter from a Markdown file. By default the data is returned as a hashtable object. It can also be returned as a PSObject or as raw Yaml formatted text.

EXAMPLES

Example 1 - Get the metadata header as a hashtable

Get-Metadata .\install\Installing-PowerShell-on-Windows.md

Name Value
---- -----
description Information about installing PowerShell on Windows
title Installing PowerShell on Windows
ms.date 08/02/2021

Example 2 - Get the metadata header as an object

Get-Metadata .\install\Installing-PowerShell-on-Windows.md -AsObject | Format-list

description : Information about installing PowerShell on Windows
file : C:\Git\PS-Docs\PowerShell-Docs\reference\docs-conceptual\install\Installing-PowerShell-on-Windows.md
title : Installing PowerShell on Windows
ms.date : 08/02/2021

Example 3 - Get the metadata header as raw Yaml

Get-Metadata .\install\Installing-PowerShell-on-Windows.md -AsYaml

description: Information about installing PowerShell on Windows
ms.date: 11/22/2024
title: Installing PowerShell on Windows

PARAMETERS

-AsJson

-AsObject

Returns the metadata as a JSON object.

Get-ParameterInfo

Mon, 01 Jan 0001 00:00:00 +0000

Get-ParameterInfo

SYNOPSIS

Gets information about a cmdlet parameter in Markdown format.

SYNTAX

AsMarkdown (Default)

Get-ParameterInfo [-ParameterName] <String[]> [-CmdletName] <String> [-ShowAll]
 [<CommonParameters>]

AsObject

Get-ParameterInfo [-ParameterName] <String[]> [-CmdletName] <String> [-AsObject]
 [<CommonParameters>]

DESCRIPTION

This cmdlet gets information about one or more parameters for a cmdlet formatted as Markdown that’s compatible with cmdlet reference documentation. You can also get the information a a PowerShell object.

This cmdlet is useful for updating existing parameters that have changed or adding new parameter when a cmdlet has been updated.

Get-ProseMetric

Mon, 01 Jan 0001 00:00:00 +0000

Get-ProseMetric

SYNOPSIS

Returns metrics about the prose in a document.

SYNTAX

Get-ProseMetric [-Path] <String[]> [-Recurse] [<CommonParameters>]

DESCRIPTION

The Get-ProseMetric cmdlet returns various metrics for a document’s prose as an object. The metrics include counts for characters, syllables, words, and more. You can use these metrics to investigate the complexity of your documents.

EXAMPLES

Example 1: Get the metrics for a file

Get-ProseMetric -Path ./README.md

characters : 2198
complex_words : 83
heading_h2 : 5
heading_h3 : 4
list : 8
long_words : 139
paragraphs : 28
polysyllabic_words : 96
sentences : 38
syllables : 755
words : 419
FileName : C:\code\pwsh\Documentarian\README.md

Example 2: Get the word count for files and folders

Get-ProseMetric .\README.md, .\CHANGELOG.md, .\Documentation\reference\cmdlets\ |
 Format-Table -Property Words, FileName

words FileName
----- --------
 17 C:\code\README.md
 3 C:\code\CHANGELOG.md
 33 C:\code\Documentation\reference\cmdlets\_index.md
 153 C:\code\Documentation\reference\cmdlets\Convert-MDLinks.md
 94 C:\code\Documentation\reference\cmdlets\Get-ContentWithoutHeader.md
 98 C:\code\Documentation\reference\cmdlets\Get-Document.md
 721 C:\code\Documentation\reference\cmdlets\Get-DocumentLink.md
 131 C:\code\Documentation\reference\cmdlets\Get-Metadata.md
 144 C:\code\Documentation\reference\cmdlets\Remove-Metadata.md
 107 C:\code\Documentation\reference\cmdlets\Set-Metadata.md
 116 C:\code\Documentation\reference\cmdlets\Update-Metadata.md

PARAMETERS

-Path

Specify the path to one or more files or folders to get the metrics for. If you specify a folder, the cmdlet returns metrics for every Markdown file in that folder.

Get-ProseReadability

Mon, 01 Jan 0001 00:00:00 +0000

Get-ProseReadability

SYNOPSIS

Returns the readability score of a markdown using Vale.

SYNTAX

ByRule (Default)

Get-Readability
 [-Path] <String[]>
 [[-ReadabilityRule] <ValeReadabilityRule[]>]
 [-Threshold <Single>]
 [-ProblemsOnly]
 [<CommonParameters>]

Preset

Get-Readability
 [-Path] <String[]>
 [-Preset <String>]
 [-ProblemsOnly]
 [<CommonParameters>]

AllRules

Get-Readability
 [-Path] <String[]>
 [-All]
 [-ProblemsOnly]
 [<CommonParameters>]

DESCRIPTION

This cmdlet uses the Vale linter to get the readability score of a Markdown file.

EXAMPLES

Example 1 - Get the FleschKincaid score of a file

Get-Readability reference\7.2\CimCmdlets\Get-CimAssociatedInstance.md FleschKincaid

Rule Score Threshold File
---- ----- --------- ----
FleschKincaid 11th Grade 8th Grade Get-CimAssociatedInstance.md

PARAMETERS

-All

Indicates that the cmdlet should return the readability scores for all known rules.

Get-ShortDescription

Mon, 01 Jan 0001 00:00:00 +0000

Get-ShortDescription

SYNOPSIS

Creates Markdown source listing each of cmdlet files in the folder and their SYNOPSIS text.

SYNTAX

Get-ShortDescription

DESCRIPTION

The cmdlet creates Markdown source listing each of cmdlet files in the folder and their SYNOPSIS text. This text is useful for updating the module Markdown file created by PlatyPS.

The cmdlet must be run in the folder containing the Markdown files for all the cmdlets in the module. The output can be sent to the clipboard for easy pasting into the module.md file.

Get-SourceFolder

Mon, 01 Jan 0001 00:00:00 +0000

Get-SourceFolder…

Get-Syntax

Mon, 01 Jan 0001 00:00:00 +0000

Get-Syntax

SYNOPSIS

Displays the syntax of a cmdlet.

SYNTAX

Get-Syntax [-CmdletName] <String> [-Markdown] [<CommonParameters>]

DESCRIPTION

The cmdlet is similar to the output you get from Get-Command -Syntax. By default, the syntax information is returned as an object. You can also return it as formatted Markdown source that can be easily pasted into a cmdlet Markdown file.

EXAMPLES

Example 1 - Get the syntax of a command as Markdown text

Get-Syntax Get-Command -Markdown

### CmdletSet (Default)

```
Get-Command [[-ArgumentList] <Object[]>] [-Verb <string[]>] [-Noun <string[]>]
 [-Module <string[]>] [-FullyQualifiedModule <ModuleSpecification[]>] [-TotalCount <int>]
 [-Syntax] [-ShowCommandInfo] [-All] [-ListImported] [-ParameterName <string[]>]
 [-ParameterType <PSTypeName[]>]
```

### AllCommandSet

```
Get-Command [[-Name] <string[]>] [[-ArgumentList] <Object[]>] [-Module <string[]>]
 [-FullyQualifiedModule <ModuleSpecification[]>] [-CommandType <CommandTypes>] [-TotalCount <int>]
 [-Syntax] [-ShowCommandInfo] [-All] [-ListImported] [-ParameterName <string[]>]
 [-ParameterType <PSTypeName[]>] [-UseFuzzyMatching] [-UseAbbreviationExpansion]
```

Example 2 - Get the syntax of a command as an object

Get-Syntax Get-Command | Format-Table -Wrap

Cmdlet ParameterSetName IsDefault Parameters
------ ---------------- --------- ----------
Get-Command CmdletSet True [[-ArgumentList] <Object[]>] [-Verb <string[]>] [-Noun <string[]>] [-Module
 <string[]>] [-FullyQualifiedModule <ModuleSpecification[]>] [-TotalCount <int>]
 [-Syntax] [-ShowCommandInfo] [-All] [-ListImported] [-ParameterName <string[]>]
 [-ParameterType <PSTypeName[]>] [<CommonParameters>]
Get-Command AllCommandSet False [[-Name] <string[]>] [[-ArgumentList] <Object[]>] [-Module <string[]>]
 [-FullyQualifiedModule <ModuleSpecification[]>] [-CommandType <CommandTypes>]
 [-TotalCount <int>] [-Syntax] [-ShowCommandInfo] [-All] [-ListImported]
 [-ParameterName <string[]>] [-ParameterType <PSTypeName[]>] [-UseFuzzyMatching]
 [-UseAbbreviationExpansion] [<CommonParameters>]

PARAMETERS

-CmdletName

The name of the cmdlet for which you want syntax information.

Get-Vale

Mon, 01 Jan 0001 00:00:00 +0000

Get-Vale

SYNOPSIS

Gets the command info for Vale installed in a workspace, user’s home folder, or on a machine.

SYNTAX

Get-Vale [<CommonParameters>]

DESCRIPTION

The Get-Vale cmdlet returns a System.Management.Automation.ApplicationInfo object for the vale binary if it’s available. It first checks for the vale application in the following order, returning the first discovered application:

It checks the .vale folder in the current working directory.
It walks the directory tree up from the current working directory, checking the .vale folder in each parent directory.
It checks the .vale folder in the user’s home directory.
It checks the folders listed in the PATH environment variable.

The cmdlet returns an error if it doesn’t find the vale application.

Get-ValeConfiguration

Mon, 01 Jan 0001 00:00:00 +0000

Get-ValeConfiguration

SYNOPSIS

Returns the current configuration for Vale as an object.

SYNTAX

Get-ValeConfiguration [[-Path] <String>] [<CommonParameters>]

DESCRIPTION

The Get-ValeConfiguration cmdlet returns a Vale configuration as an object.

EXAMPLES

Example 1: Get the workspace Vale configuration

Get-ValeConfiguration

BlockIgnores :
Checks : {PowerShell-Docs.Passive, Vale.Spelling, alex.Ablist…}
Formats :
Asciidoctor :
FormatToLang :
GBaseStyles :
GChecks :
IgnoredClasses :
IgnoredScopes :
MinAlertLevel : 0
Vocab : {Base}
RuleToLevel :
SBaseStyles : @{*.md=System.Object[]}
SChecks : @{*.md=}
SkippedScopes :
Stylesheets :
StylesPath : C:/code/Documentarian/.vscode/styles
TokenIgnores :
WordTemplate :
DictionaryPath :
NLPEndpoint :

Example 2: Get a specific Vale configuration

Get-ValeConfiguration -Path /code/site/.vale.ini

BlockIgnores : @{*.md=System.Object[]}
Checks : {alex.Ablist, alex.Gendered, alex.ProfanityLikely, alex.ProfanityMaybe…}
Formats :
Asciidoctor :
FormatToLang :
GBaseStyles :
GChecks :
IgnoredClasses :
IgnoredScopes :
MinAlertLevel : 0
Vocab : {Base}
RuleToLevel :
SBaseStyles : @{*.md=System.Object[]}
SChecks : @{*.md=}
SkippedScopes :
Stylesheets :
StylesPath : C:/code/site/.vscode/styles
TokenIgnores : @{*.md=System.Object[]}
WordTemplate :
DictionaryPath :
NLPEndpoint :

PARAMETERS

-Path

Specify the path to a Vale configuration file (typically .vale.ini) to return as an object.

HasReference

Mon, 01 Jan 0001 00:00:00 +0000

Returns whether the DocumentLink instance’s Kind reference link.

InlineLinks

Mon, 01 Jan 0001 00:00:00 +0000

Returns every inline (non-reference) link from the document.

InsideSingleBacktick

Mon, 01 Jan 0001 00:00:00 +0000

Returns a pattern for finding the value wrapped in backticks in another string.

InSquareBrackets

Mon, 01 Jan 0001 00:00:00 +0000

Returns a standard pattern for finding everything inside square brackets.

Install Documentarian and related tools

Mon, 01 Jan 0001 00:00:00 +0000

Install tools

Install PowerShell modules

Requirements:

PowerShell version 7.2 or later
The PowerShell-Yaml module. You can install it from the PowerShell Gallery:
```
Install-Module -Name PowerShell-Yaml
```

Next, you need to download the latest build from the Documentarian GitHub repository.

Select the latest successful workflow run for the Build Modules GitHub Action.
In Artifacts, download the Documentarian zip file.
Extract the Documentarian module from the zip file.
Import the modules into your PowerShell session. For example, Import-Module Documentarian.psd1.

Install VS Code extensions

Install Vale VS Code extension
Install Error lens extension

Install-Vale

Mon, 01 Jan 0001 00:00:00 +0000

Install-Vale

SYNOPSIS

Installs Vale to the current working directory or the user’s home folder.

SYNTAX

Install-Vale
 [[-Version] <String>]
 [[-Scope] <ValeInstallScope>]
 [-PassThru]
 [<CommonParameters>]

DESCRIPTION

The Install-Vale cmdlet is a helper for installing Vale into a project folder or the user’s home directory. When used, it installs Vale into the .vale folder of the current directory by default. You can specify the Scope parameter as User to install Vale into the .vale folder in your home directory instead.

Invoke-NewMDHelp

Mon, 01 Jan 0001 00:00:00 +0000

Invoke-NewMDHelp

SYNOPSIS

Creates Markdown help files for the cmdlets in a module.

SYNTAX

Invoke-NewMDHelp [-Module] <Object> [-OutPath] <Object>

DESCRIPTION

This cmdlet is a wrapper for the New-MarkdownHelp cmdlet from the PlatyPS module. It runs New-MarkdownHelp with the standard set of parameters we use for our documentation at Microsoft.

The target module must be loaded in your current session and you must have the PlatyPS module installed.

EXAMPLES

Example 1

Invoke-NewMDHelp -Module Documentarian -OutPath .\Documentarian

PARAMETERS

-Module

The name of the module that you want to document.

Invoke-Pandoc

Mon, 01 Jan 0001 00:00:00 +0000

Invoke-Pandoc

SYNOPSIS

Invokes Pandoc to convert Markdown files to plain text files.

SYNTAX

Invoke-Pandoc [[-Path] <String[]>] [[-OutputPath] <String>] [-Recurse]

DESCRIPTION

This cmdlet is a wrapper for Pandoc, a command-line tool that converts documents from one format to another. The cmdlet runs pandoc.exe with the standard set of parameters we use for our documentation at Microsoft. Pandoc is the tool we use to convert PowerShell about_*.md files to plain text, which is the format required by the PowerShell help system.

Invoke-Vale

Mon, 01 Jan 0001 00:00:00 +0000

Invoke-Vale

SYNOPSIS

Calls the vale executable and returns the result as a PowerShell object.

SYNTAX

Get-Vale -ArgumentList <String[]> [<CommonParameters>]

DESCRIPTION

The Invoke-Vale cmdlet calls the vale binary and a PSCustomObject representing the JSON output. It makes it simpler to retrieve structured output from Vale.

The cmdlet automatically appends the --output JSON flag and value to your argument list, ensuring that Vale always returns structured output when it can.

It also has specific error-handling for common Vale errors, reducing the need for troubleshooting and parsing strings to understand what went wrong.

IsImage

Mon, 01 Jan 0001 00:00:00 +0000

Returns whether the DocumentLink instance’s Kind is an image.

IsReference

Mon, 01 Jan 0001 00:00:00 +0000

Returns whether the DocumentLink instance’s Kind is a reference definition.

IsSelfReferential

Mon, 01 Jan 0001 00:00:00 +0000

Returns whether the DocumentLink instance’s Kind is self-reference.

IsText

Mon, 01 Jan 0001 00:00:00 +0000

Returns whether the DocumentLink instance’s Kind is text.

LinkKind

Mon, 01 Jan 0001 00:00:00 +0000

Distinguishes the type of link in a Markdown file.

MarkdownExtension

Mon, 01 Jan 0001 00:00:00 +0000

Distinguishes the type of source file for processing.

New-AstPredicate

Mon, 01 Jan 0001 00:00:00 +0000

New-AstPredicate…

New-Builder

Mon, 01 Jan 0001 00:00:00 +0000

New-Builder

SYNOPSIS

Creates an instance of the MarkdownBuilder object.

SYNTAX

FromContent (Default)

New-Builder [-Content <String>]
 [-DefaultLineEnding <LineEnding>]
 [-DefaultCodeFenceCharacter <CodeFenceCharacter>]
 [-DefaultCodeFenceLength <Int32>]
 [<CommonParameters>]

FromStringBuilder

New-Builder [-StringBuilder <StringBuilder>]
 [-DefaultLineEnding <LineEnding>]
 [-DefaultCodeFenceCharacter <CodeFenceCharacter>]
 [-DefaultCodeFenceLength <Int32>]
 [<CommonParameters>]

DESCRIPTION

The New-Builder function creates an instance of the MarkdownBuilder class. You can use this object to programmatically write Markdown in your PowerShell functions and scripts. You can pass the MarkdownBuilder object to the other functions in this module, like Add-Line and Start-CodeFence.

New-ValeConfiguration

Mon, 01 Jan 0001 00:00:00 +0000

New-ValeConfiguration

SYNOPSIS

Create a minimal configuration file for Vale.

SYNTAX

New-ValeConfiguration
 [[-FilePath] <String>]
 [[-StylesPath] <String>]
 [[-MinimumAlertLevel] <ValeAlertLevel>]
 [[-StylePackage] <String[]>]
 [-Force]
 [-PassThru]
 [-NoSpelling]
 [-NoSync]
 [<CommonParameters>]

DESCRIPTION

The New-ValeConfiguration cmdlet is a helper function for creating a basic Vale configuration file. By default, it creates the .vale.ini file in the working directory with the same settings as Vale’s own configuration generator and then immediately syncs the newly created configuration.

You can use the FilePath parameter to create the configuration file in a different location or with a different name. You can use the StylesPath to change where style packages are placed when you use the Sync-Vale command.

NotInsideInlineCode

Mon, 01 Jan 0001 00:00:00 +0000

Returns whether a string of text is inside any inline code blocks for a given line of Markdown.

Parse

Mon, 01 Jan 0001 00:00:00 +0000

Inspects a Markdown document for any links inside it.

ParsedLinks

Mon, 01 Jan 0001 00:00:00 +0000

Returns the parsed links from the document, parsing if needed or if Force is $true.

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the DocumentLink class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ParsedDocument class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ParsingPatterns class.

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the Position class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeApplicationInfo class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeConfigurationEffective class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeConfigurationFormatLanguageAssociation class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeConfigurationFormatTransform class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeConfigurationFormatTypeAssociation class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeConfigurationIgnore class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeMetricsHeadingCount class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeMetricsInfo class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeRule class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeStyle class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeViolationAction class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeViolation class

Properties

Mon, 01 Jan 0001 00:00:00 +0000

Properties for the ValeViolationPosition class

ReferenceDefinitions

Mon, 01 Jan 0001 00:00:00 +0000

Returns every reference link definition from the document.

ReferenceLinks

Mon, 01 Jan 0001 00:00:00 +0000

Returns every reference link from the document.

ReferenceLinksAndDefinitions

Mon, 01 Jan 0001 00:00:00 +0000

Returns every reference link and definition from the document.

Remove-Metadata

Mon, 01 Jan 0001 00:00:00 +0000

Remove-Metadata

SYNOPSIS

Removes metadata key-value pairs from the YAML frontmatter of a Markdown file.

SYNTAX

Remove-Metadata [-Path] <string> [-KeyName] <string[]> [-Recurse] [<CommonParameters>]

DESCRIPTION

Removes metadata key-value pairs from the YAML frontmatter of a Markdown file. List the keys names you want to remove from the frontmatter. This is useful for removing obsolete metadata values.

EXAMPLES

Example 1 - Remove obsolete metadata values

In this example, the target Markdown file contains two obsolete keys: keywords and ms.assetid.

Resolve-SourceDependency

Mon, 01 Jan 0001 00:00:00 +0000

Resolve-SourceDependency…

Resolve-SourceFolderPath

Mon, 01 Jan 0001 00:00:00 +0000

Resolve-SourceFolderPath…

Set-Metadata

Mon, 01 Jan 0001 00:00:00 +0000

Set-Metadata

SYNOPSIS

Overwrites the metadata frontmatter in a Markdown file.

SYNTAX

Set-Metadata [-Path] <string> [-NewMetadata] <hashtable> [-Recurse] [<CommonParameters>]

DESCRIPTION

Overwrites the metadata frontmatter in a Markdown file. The existing frontmatter is replaced with the values in the NewMetadata hashtable.

EXAMPLES

Example 1 - Replace the existing metadata with new values

$newvalues = @{
 'ms.date' = Get-Date -Format 'MM/dd/yyyy'
 test='foo'
}
Update-Metadata .\docs\*.md -NewMetadata $newvalues

PARAMETERS

-NewMetadata

This is a hashtable of key-value pairs to be written to the Markdown file.

Sort-Parameters

Mon, 01 Jan 0001 00:00:00 +0000

Update-ParameterOrder

SYNOPSIS

Sorts the H3 parameter blocks of a cmdlet Markdown file.

SYNTAX

Sort-Parameters [-Path] <string[]> [<CommonParameters>]

DESCRIPTION

The PowerShell-Docs style guide recommends that the H3 parameter blocks of a cmdlet Markdown file be sorted alphabetically with the Confirm and WhatIf parameters at the end of the list. However, much of the existing reference content was created before this recommendation. Therefore, not all cmdlet files are ordered this way.

This cmdlet allows you to easily reorder the parameters.

SourceCategory

Mon, 01 Jan 0001 00:00:00 +0000

Distinguishes the type of source file for processing.

SourceScope

Mon, 01 Jan 0001 00:00:00 +0000

Distinguishes the scope of source file for processing.

Start-CodeFence

Mon, 01 Jan 0001 00:00:00 +0000

Start-CodeFence

SYNOPSIS

Starts a new code fence in a MarkdownBuilder object.

SYNTAX

Start-CodeFence [[-Language] <String>]
 [[-Builder] <MarkdownBuilder>]
 [[-Character] <CodeFenceCharacter>]
 [[-Length] <Int32>]
 [[-LineEnding] <LineEnding>]
 [-PassThru]
 [<CommonParameters>]

DESCRIPTION

The Start-CodeFence function opens a new fenced code block in a MarkdownBuilder object. The MarkdownBuilder keeps internal track of opened code fences and ensures that they have enough fence characters to be valid when they include a nested code fence. You can specify the fence character and length or use the defaults for the MarkdownBuilder object. When you’re done adding code in the fence, you can use the Stop-CodeFence function to close the fence.

Stop-CodeFence

Mon, 01 Jan 0001 00:00:00 +0000

Stop-CodeFence

SYNOPSIS

Stops the last opened code fence in a MarkdownBuilder object.

SYNTAX

Stop-CodeFence [[-Builder] <MarkdownBuilder>]
 [[-LineEnding] <LineEnding>]
 [-PassThru]
 [<CommonParameters>]

DESCRIPTION

The Stop-CodeFence function closes the most recently opened fenced code block in a MarkdownBuilder object. The MarkdownBuilder keeps internal track of opened code fences and ensures that the closing fence has the correct characters and length.

Sync-BeyondCompare

Mon, 01 Jan 0001 00:00:00 +0000

Sync-BeyondCompare

SYNOPSIS

Provides a simple way to synchronize changes across multiple versions of a Markdown file.

SYNTAX

Sync-BeyondCompare [-Path] <String>

DESCRIPTION

Many docsets at Microsoft contain multiple versions of the same reference document. For example, we support multiple versions of PowerShell cmdlets. Each version contains the same cmdlet but there may be minor differences between the versions.

When you make a change to the documentation for one of these cmdlet, it’s often necessary to make the same change across all the supported versions.

Sync-Vale

Mon, 01 Jan 0001 00:00:00 +0000

Sync-Vale

SYNOPSIS

Installs or updates the Vale style packages for a configuration.

SYNTAX

Sync-Vale [-Path <String>] [<CommonParameters>]

DESCRIPTION

The Sync-Vale cmdlet installs or updates the Vale style packages for a configuration. If the style packages don’t exist in the configured style path, the cmdlet installs them there. If the style packages exist, the cmdlet updates them if needed.

By default, this cmdlet synchronizes the .vale.ini configuration file in the current working directory.

Sync-VSCode

Mon, 01 Jan 0001 00:00:00 +0000

Sync-VSCode

SYNOPSIS

Provides a simple way to synchronize changes across multiple versions of a Markdown file.

SYNTAX

Sync-VSCode [-Path] <String>

DESCRIPTION

When you make a change to the documentation for one of these cmdlet, it’s often necessary to make the same change across all the supported versions.

Test-HelpInfoUri

Mon, 01 Jan 0001 00:00:00 +0000

Test-HelpInfoUri

SYNOPSIS

Checks for the existence of the help info XML file used to update help for a module.

SYNTAX

ByName (Default)

Test-HelpInfoUri [-Module] <string[]> [[-HelpInfoUri] <uri>] [-OutPath <string>]
 [<CommonParameters>]

ByObject

Test-HelpInfoUri [[-HelpInfoUri] <uri>] [-InputObject <Object>] [-OutPath <string>]
 [<CommonParameters>]

DESCRIPTION

To support updateable help, a module must have a *_HelpInfo.xml file published to a web server and the module manifest must have a HelpInfoUri property that points to the location of the file. This cmdlet attempts to download the *_HelpInfo.xml file for a module.

Test-Prose

Mon, 01 Jan 0001 00:00:00 +0000

Test-Prose

SYNOPSIS

Test a document’s prose with Vale rules.

SYNTAX

Test-Prose [[-Path] <String[]>] [[-ConfigurationPath] <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet tests a document’s prose with configured Vale rules, returning an object for style rule violation. The returned object includes detailed information about where and how the document violated a style rule.

EXAMPLES

Example 1: Test a specific document

Test-Prose -Path ./README.md

Action : @{Name=; Params=}
Span : {18, 20}
Check : Microsoft.Acronyms
Description :
Link : https://docs.microsoft.com/en-us/style-guide/acronyms
Message : 'MIT' has no definition.
Severity : suggestion
Match : MIT
Line : 10
FileInfo : C:\code\pwsh\Documentarian\README.md

Action : @{Name=replace; Params=System.Object[]}
Span : {5, 11}
Check : Microsoft.ComplexWords
Description :
Link : https://docs.microsoft.com/en-us/style-guide/word-choice/
 use-simple-words-concise-sentences
Message : Consider using 'give' or 'offer' instead of 'provide'.
Severity : suggestion
Match : provide
Line : 25
FileInfo : C:\code\pwsh\Documentarian\README.md

Example 2: Test a folder

Test-Prose -Path ./reference/cmdlets/

Count Name
----- ----
 4 C:\Documentarian\Documentation\reference\cmdlets\Convert-MDLinks.md
 2 C:\Documentarian\Documentation\reference\cmdlets\Get-ContentWithoutHeader.md
 2 C:\Documentarian\Documentation\reference\cmdlets\Get-Document.md
 15 C:\Documentarian\Documentation\reference\cmdlets\Get-DocumentLink.md
 2 C:\Documentarian\Documentation\reference\cmdlets\Get-Metadata.md
 3 C:\Documentarian\Documentation\reference\cmdlets\Remove-Metadata.md
 2 C:\Documentarian\Documentation\reference\cmdlets\Set-Metadata.md
 2 C:\Documentarian\Documentation\reference\cmdlets\Update-Metadata.md

PARAMETERS

-ConfigurationPath

Specify the path to a Vale configuration file—typically .vale.ini—to use for the tests. By default, Vale infers the configuration based on current working directory.

Test-YamlTOC

Mon, 01 Jan 0001 00:00:00 +0000

Test-YamlTOC

SYNOPSIS

Validates that all entries in the TOC exist and that all files in the repository are in the TOC.

SYNTAX

Test-YamlTOC [-Path] <String> [<CommonParameters>]

DESCRIPTION

The command recursively searches the path provided to find TOC.yml files. It reads the content of each TOC.yml file and resolves the full path for each entry in the TOC. The command then checks if the file exists in the repository.

The path provided must be a folder.

ToDecoratedString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the VT100-encoded string representing the rendered markdown for the document.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a position.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a ValeApplicationInfo instance.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a ValeConfigurationEffective instance.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a ValeConfigurationFormatTypeAssociation instance.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a ValeRule instance.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a ValeStyle instance.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a ValeViolationAction instance.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a ValeViolation instance.

ToString

Mon, 01 Jan 0001 00:00:00 +0000

Returns the string representation of a ValeViolationPosition instance.

Transform

Mon, 01 Jan 0001 00:00:00 +0000

Converts the input object into one or more matching LinkKind enums.

UndefinedReferenceLinks

Mon, 01 Jan 0001 00:00:00 +0000

Returns every reference link that doesn’t have a matching reference link definition from the document.

UnusedReferenceLinkDefinitions

Mon, 01 Jan 0001 00:00:00 +0000

Returns every reference link definition that doesn’t have at least one matching reference link from the document.

Update-Headings

Mon, 01 Jan 0001 00:00:00 +0000

Update-Headings

SYNOPSIS

Changes the standard headings in about_ files and cmdlet reference to title case.

SYNTAX

Update-Headings [-Path] <String> [-Recurse] [<CommonParameters>]

DESCRIPTION

Changes the standard headings in about_ files and cmdlet reference to title case.

EXAMPLES

Example 1 - Update the heading for all files in a folder tree

Update-Headings -Path ./reference/5.1/Microsoft.PowerShell.Core/*.md -Recurse

PARAMETERS

-Path

The path to the Markdown files to be updated. Wildards are supported.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Recurse

Use this parameter to search all subfolders of the specified Path.

Update-Metadata

Mon, 01 Jan 0001 00:00:00 +0000

Update-Metadata

SYNOPSIS

Updates or adds metadata to a Markdown file.

SYNTAX

Update-Metadata [-Path] <string> [-NewMetadata] <hashtable> [-Recurse] [<CommonParameters>]

DESCRIPTION

Updates or adds metadata to a Markdown file. The existing keys in the frontmatter are update with the new values. New keys are added to the frontmatter.

EXAMPLES

Example 1 - Update the ms.date metadata for all Markdown files

Update-Metadata *.md -NewMetadata @{'ms.date' = Get-Date -Format 'MM/dd/yyyy' }

PARAMETERS

-NewMetadata

This is a hashtable of key-value pairs to be written to the Markdown file.

Update-SourceDependency

Mon, 01 Jan 0001 00:00:00 +0000

Update-SourceDependency…

ValeAlertLevel

Mon, 01 Jan 0001 00:00:00 +0000

Defines the severity of a Vale rule violation.

ValeInstallScope

Mon, 01 Jan 0001 00:00:00 +0000

Defines where Install-Vale should install the application

ValidReferenceLinksAndDefinitions

Mon, 01 Jan 0001 00:00:00 +0000

Returns every reference link that isn’t undefined and every reference link definition that isn’t unused from the document.