(AB-4196) Codify markdownlint #92
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Prior to this change, the repository had no markdownlint configuration. This change adds configuration based on the rules defined in the MicrosoftDocs/PowerShell-Docs project.
The root-folder
.markdownlint.json
file specifies the enforced syntax for Markdown files in this project.The root-folder
.markdownlint-cli2.yaml
file governs the behavior of the linter overall. The settings included are minimal and do not effect the editing experience. This file may require iteration for advanced usage later.In every
About
folder for reference content, this change adds a.markdownlint.json
file. When editing Markdown in VS Code, the editor uses the closest configuration file to the edited document. That allows us to override and specify alternate rules on a per-folder basis.In this change, the configuration files in the
About
folders:line-length
rule, setting the maximum line length for code blocks to 74 characters and for other text to 79 characters.This is to accomodate the PowerShell Help System's line length requirements.In the
rules
folder for PSScriptAnalyzer's conceptual content, this change adds a.markdownlint.json
file which ignores the markdownlint ruleno-emphasis-as-heading
. PSSA rules indicate their severity level by a single line of emphasized text.This change is related to AB#4196 and AB#4197.
PR Checklist