docs: format markdown files #73
Open
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reformats markdown files across the repository to comply with markdownlint best practices. The changes improve documentation readability and consistency by standardizing code block formatting, indentation within lists, and language specifiers.
Key changes:
- Removes shell prompt characters (
$) from bash code blocks to facilitate copy-paste operations - Properly indents code blocks within numbered list items with 4 spaces
- Adds explicit
textlanguage specifiers to code fences containing plain text examples
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/x11.md | Indents all code blocks with 4 spaces to properly nest them under numbered list items |
| README.md | Removes $ prompts from bash commands, converts URL to markdown link format, properly indents nested code block, and adds blank line after "Note:" heading |
| CONTRIBUTING.md | Adds text language specifier to code fences containing commit message examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Format markdown files.
Additional Context
Follow the recommend rules