chore: add markdownlint on pre-commit hook and lint md files #996
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR introduces markdownlint into the pre-commit workflow and applies linting fixes to markdown files to enforce consistent documentation style.
- Add
.markdownlint.yamlwith project-specific markdownlint rules. - Integrate
markdownlint-cli2into.pre-commit-config.yamlfor automated markdown linting and fixing. - Adjust formatting across example READMEs and root docs (remove stray list markers, normalize blank lines, angle-bracket links).
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| .pre-commit-config.yaml | Added markdownlint-cli2 hook for markdown linting (--fix). |
| .markdownlint.yaml | Defined markdownlint rules (list style, indentation, line length, inline HTML, etc.). |
| examples/servers/simple-streamablehttp/README.md | Removed stray list items and fixed blank-line spacing. |
| examples/servers/simple-streamablehttp-stateless/README.md | Deleted extra blank list entries and corrected spacing. |
| examples/servers/simple-auth/README.md | Normalized list markers, removed double-dash item, and added blank lines before sections. |
| examples/clients/simple-chatbot/README.MD | Inserted blank lines around code and note blocks. |
| SECURITY.md | Added blank line after the top-level heading. |
| README.md | Added blank lines before code blocks and example lists. |
| CODE_OF_CONDUCT.md | Wrapped email and URLs in angle brackets for link syntax. |
| CLAUDE.md | Inserted blank lines around commit trailer examples. |
0c538ce to
c958e8d
Compare
c958e8d to
37eb86f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Add markdownlint on pre-commit hook for linting and formatting markdown files
.markdownlint.yaml: Added markdown linting rules with configurations for unordered list style, indentation, line length, inline HTML, and more..pre-commit-config.yaml: Integratedmarkdownlint-cli2into pre-commit hooks for automated markdown linting and fixing.Motivation and Context
To style all documentation files and ensure that everyone adheres to the same standards
How Has This Been Tested?
Run
pre-commit run --all-filesTypes of changes
Checklist