Skip to content

Commit 936eef6

Browse files
authored
Merge pull request #986 from DuendeSoftware/mb/readme
Document markdown style guidelines in README.md
2 parents 1746394 + f8ee5cd commit 936eef6

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,13 @@ WebStorm has Grazie as a built-in spell checker and grammar checker, and support
6666
* Run `npm run linkchecker` to validate all links (note this will ignore links to GitHub because of rate limits in place).
6767
* 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]`
6868

69+
### Markdown Style
70+
71+
* Use `*` for lists. Do not use `-`.
72+
* Use `[link title](https://example.com)` for links, avoid reference-style links unless you need to repeat the same link multiple times.
73+
* For internal links, always include the extension (e.g. `.md` or `.mdx`)
74+
* Prefer `csharp` over `cs` to set the language for C# code blocks.
75+
6976
### Code Block Style
7077

7178
* Use triple backticks to enclose code blocks.

0 commit comments

Comments
 (0)