PSA: It may look like a pretty beefy PR, but it isn't. Most of the added/deleted lines are due to formatting and linting fixes. 😉
I am introducing the GitHub Actions for linting and formatting all Markdown files within the project using markdownlint-cli and prettier. To get this GitHub Action to pass, I had to format and lint each Markdown file. I have also disabled quite a few rules for markdownlint-cli & prettier to conserve the current structure for referencing images and other forms of content.
You can view all of the disabled & enabled rules for markdownlint-cli in .config/.markdownlint-cli.yaml, and prettier in .config/.prettierrc file.
In addition, there is an end-user guide for everyone who uses VS Code on how to install and configure the extensions for easier formatting and linting, which is located here: docs/training/lint_format_user_guide.md
Summary
I am introducing the GitHub Actions for linting and formatting all Markdown files within the project using markdownlint-cli and prettier. To get this GitHub Action to pass, I had to format and lint each Markdown file. I have also disabled quite a few rules for markdownlint-cli & prettier to conserve the current structure for referencing images and other forms of content.
You can view all of the disabled & enabled rules for markdownlint-cli in
.config/.markdownlint-cli.yaml, and prettier in.config/.prettierrc file.In addition, there is an end-user guide for everyone who uses VS Code on how to install and configure the extensions for easier formatting and linting, which is located here:
docs/training/lint_format_user_guide.mdLinked issues
212
210
Supported Links