Ник, воистину хороший пост получился, прожженный Docs as code

А еще можно погрузиться на один уровень глубже и сказать, что автор точно так же не должен руками править количество пустых строк между абзацами, оставлять trailing spaces и руками форматировать таблицы в markdown

В мире JavaScript-разработки сейчас очень популярен инструмент prettier. Если вкратце и упрощенно, что он преобразует ваш код в абстрактное синтаксическое дерево и возвращает вам его отформатированным так, как считает нужным. Никаких больше споров по поводу того, сколько пробелов должно быть в начале строки и какие должны быть кавычки.

А самое интересное — в него встроен парсер для маркдауна!

Здесь https://prettier.io/playground/ можно посмотреть примеры (в настройках нужно выбрать --parser markdown)

Если кому-то интересно углубиться еще сильнее, то из того же мира JS-разработки можно взять инструменты https://github.com/okonet/lint-staged и https://github.com/typicode/husky и достаточно просто настроить ваш репозиторий так, чтобы при добавлении и/или изменении в гите md-файлов они автоматически форматировались этим самым prettier

(но это можно сделать и настроив руками precommit-хук)

Don't say "simply" ))

я начал убирать "очевидно" и "просто" до этого сообщения! 😄

А если у вас есть обширная документация в markdown в вики на гитхабе и вы не хотите руками прогонять все через prettier на сайте, то надо не забывать, что вики на гитхабе это еще один репозиторий и его можно изменять локально https://help.github.com/articles/adding-and-editing-wiki-pages-locally/

Я написал две больших статьи как работать с маркдауном правильно и красиво в Атоме где-то тут https://t.me/technical_writing

@rgusev может вы знаете инструмент, который бы проставлял в тексте неразрывные пробелы, тире и кавычки? Тоже чтобы кодом и opensource

https://www.artlebedev.ru/typograf/ ?

Это в лучшем случае через API

Если я правильно понял, то https://github.com/denysdovhan/typographic-markdown  — что-то похожее, но сам, если честно, не пользовался

А я хочу такой, чтобы подключить его к редактору или в коде, который документацию собирает

и не похоже, что развивается активно 😞

о! охуенно, две недели назад такое искал

Кстати, здесь есть одна фича, которая меня очень удивила в своё время: вставки кода внутри маркдауна он тоже форматирует
т.е. что-то вроде
```js
function f(
some,
weird,
formatting) {return [some, weird,
formatting]}
```
чудесным образом превратится в

```js
function f(some, weird, formatting) {
  return [some, weird, formatting];
}
```

а
```css
.warning {color:red}
.success {color: green
}
.warning, .success{font-size: 16px;}
```
в

```css
.warning {
  color: red;
}
.success {
  color: green;
}
.warning,
.success {
  font-size: 16px;
}
```

В общем, я могу долго рекламировать prettier 😄

шел 2018й, люди открывали для себя приттифаеры кода

Тут же не просто так, а внутри маркдауна )