Markdown
Лёгкий язык разметки, в котором форматирование текста задаётся простыми символами и затем преобразуется в HTML или другой целевой формат.
Подробно
Markdown — облегчённый язык разметки, созданный для того, чтобы писать структурированный текст в обычном виде, не отвлекаясь на теги. Заголовки обозначаются символами #, списки — дефисами или звёздочками, выделение — парой * или _, а блоки кода обрамляются тройными обратными кавычками с указанием языка. Документ в формате .md читается как обычный текст, а рендерер (GitHub, GitLab, конвертеры вроде marked) превращает его в HTML. Практически вся документация в открытых проектах — README.md, CHANGELOG.md, файлы в docs/, описания pull request'ов и комментарии — пишется на Markdown. Тема markdown входит в число ключевых в подборке GitHubDaily, что отражает её повсеместное использование в разработке.
Примеры употребления
- README.md с заголовком `# Название проекта` и badges
- Блок кода: ```bash\nnpm install\n```
- Таблица в описании API: `| Метод | Путь | Описание |`
- Чек-лист в issue: `- [x] написать тесты`