PowerShell-Docs

The style package for authoring documentation for PowerShell.

This Vale style package includes numerous rules and configuration used by the PowerShell technical writers for linting the official documentation.

It’s intended to be used as a convenient starting point for anyone authoring or maintaining PowerShell content.

You can always find the latest release of the package here:

https://deploy-preview-153–quiet-snickerdoodle-38a82c.netlify.app/packages/vale/PowerShell-Docs.zip

Reference

Reference documentation for the style package. You can find information about the configuration and inspect the definition and reasoning for each rule.

Changelog

All notable changes to the PowerShell-Docs style package are documented in this file.

This changelog’s format is based on Keep a Changelog and this project adheres to Semantic Versioning.

For releases before 1.0.0, this project uses the following convention:

  • While the major version is 0, the code is considered unstable.
  • The minor version is incremented when a backwards-incompatible change is introduced.
  • The patch version is incremented when a backwards-compatible change or bug fix is introduced.