Style Configuration

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

less than a minute

Definition
StylesPath = styles
Packages = Microsoft, alex

[*.md]
BasedOnStyles = Vale, Microsoft, alex

alex.Ablist = NO                # Doesn't apply to our content
alex.ProfanityLikely = NO       # Doesn't apply to our content
alex.ProfanityMaybe = NO        # Doesn't apply to our content
alex.ProfanityUnlikely = NO     # Doesn't apply to our content

Microsoft.HeadingAcronyms = NO  # Too noisy for our docset
Microsoft.Headings = NO         # Too noisy for our docset
Microsoft.Passive = NO          # Too noisy
Microsoft.Negative = NO         # Prefer to not use endash
Microsoft.Spacing = NO          # Use PowerShell-Docs rule
Microsoft.We = NO               # Too noisy when we want to use First Person
Microsoft.Vocab = NO            # Too noisy
Microsoft.RangeFormat = NO      # Doesn't apply for markdown
Microsoft.Ranges = NO           # Doesn't apply for markdown
Microsoft.GeneralURL = NO       # Doesn't apply for our audience

; PowerShell-Docs.Passive = NO    # Too noisy

The PowerShell-Docs style package includes a .vale.ini configuration. The configuration definition allows the PowerShell-Docs style to build on the Microsoft and alex styles. When you specify PowerShell-Docs in the BasedOnStyles key for your own configuration, these other styles are included automatically.

The configuration also turns off existing rules in those styles as they are replaced or not needed when working on documentation for PowerShell projects.

Last modified March 3, 2023: (MAINT) Rename Source folder to Projects (8b45aed)