Skip to content

Commit

Permalink
Specify hyphens for bulleted lists (exercism#399)
Browse files Browse the repository at this point in the history
There has been some churn in the problem specifications due
to hyphens being switched from hyphens to asterisks and back.

The team has settled on using hyphens for lists.
  • Loading branch information
kytrinyx authored Oct 27, 2022
1 parent 24fc7ac commit 4aab797
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions building/markdown/markdown.md
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

0 comments on commit 4aab797

Please sign in to comment.