Markdown style guide для технической документации

Markdown style guide для технической документации

Хорошо структурированный Markdown проще ревьюить, проверять и конвертировать.

Соблюдайте иерархию заголовков

Не перескакивайте с ## на ####. Увеличивайте уровень по одному.

Используйте fenced code blocks

Всегда указывайте язык:

const value = "example";

Делайте таблицы читабельными

• Выравнивайте колонки
• Избегайте слишком широких таблиц
• Для сложных блоков чаще подходят списки

Автоматизируйте очистку

Перед публикацией используйте инструменты, которые нормализуют отступы, заголовки и trailing-пробелы.