Skip to content

Specify hyphens for bulleted lists #399

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
kytrinyx merged 1 commit into from
Oct 27, 2022
Merged

Specify hyphens for bulleted lists #399

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions building/markdown/markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,10 @@ Nearly everything with Exercism has been debated, discussed and rewritten many t
Exercism is a very intentional product - things are there because they've been designed to be there, and things are often left out because they've been designed to be left out.
```

## Lists

Use the hyphen character (`-`) as the bullet list marker for unordered lists.

## Comments

- Prefer Markdown comments instead of HTML comments (e.g. use `[comment]: # (Actual comment...)` rather than `<!-- Actual comment -->`
Expand All @@ -152,6 +156,7 @@ There are various rules you can use to configure linters to meet this spec:
- [MD001][MD001]: Enable
- [MD002][MD002]: Enable
- [MD003][MD003]: Use `atx` style
- [MD004][MD004]: Use `dash` style
- [MD013][MD013]: Disable
- [MD033][MD033]: Disable

Expand Down