donejs / donejs/developer-relations

Use 2 spaces instead of 4 spaces (or tabs) in *.md

Open
#25 0 comments 0 reactions 0 assignees View on GitHub
discussion documentation
Dominant language
JavaScript
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

If you use **Spaces — 2**, you can indent lists:

![image](https://cloud.githubusercontent.com/assets/990216/24327177/e8bfb0f4-118f-11e7-95d5-bbedbf8e101e.png)

However, if you try and do the same thing with **Tabs — 2 or 4**, indenting always results in code formatting:

![image](https://cloud.githubusercontent.com/assets/990216/24327180/f838d056-118f-11e7-9db9-e40da8b2a5b2.png)

So, 2 spaces gives the most flexibility, because you can do:

---

- list item
- another

AND:

- list item in code format
- another in code format

---

Like that:

---

```
- list item
- another

AND:

- list item in code format
- another in code format
```

---

This means `.editorconfig`s [like this](https://github.com/stealjs/steal/blob/master/.editorconfig) should look more like:

```
; Unix-style newlines
[*]
end_of_line = LF
indent_style = tab
indent_size = 4

[{*.json,*.yml,*.md}]
indent_style = space
indent_size = 2
```

(notice addition of `*.md`)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.