Skip to content

Document markdown style guidelines in README.md #986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maartenba merged 3 commits into from
Jan 19, 2026
Merged

Document markdown style guidelines in README.md #986

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd21fac
Document markdown style guidelines in README.md
maartenba Jan 19, 2026
329d1f7
Update README.md
maartenba Jan 19, 2026
f8ee5cd
Update README.md
maartenba Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,13 @@ WebStorm has Grazie as a built-in spell checker and grammar checker, and support
* Run `npm run linkchecker` to validate all links (note this will ignore links to GitHub because of rate limits in place).
* When a markdown link is long (75+ characters) or a link is repeated multiple times on a page, prefer moving the link to the bottom of the file and using markdown anchor syntax `[test.cs][repo-test-file]`

### Markdown Style

* Use `*` for lists. Do not use `-`.
* Use `[link title](https://example.com)` for links, avoid reference-style links unless you need to repeat the same link multiple times.
* For internal links, always include the extension (e.g. `.md` or `.mdx`)
* Prefer `csharp` over `cs` to set the language for C# code blocks.

### Code Block Style

* Use triple backticks to enclose code blocks.
Expand Down
Loading