Русский
Пишите в Markdown с живым предпросмотром.
Последнее обновление
Markdown-редактор — это рабочая среда с двумя панелями: в одной вы набираете текст в синтаксисе Markdown, в другой в режиме реального времени обновляется отрендеренный результат. На этом формате держатся README на GitHub, порталы документации, генераторы статических сайтов, блог-платформы, заметочники вроде Obsidian и чаты типа Discord и Slack.
Главная идея Markdown — оставаться читаемым в виде обычного текста и при этом превращаться в структурированный HTML при отображении. Меньше возни с панелями форматирования, больше времени на сам текст — именно поэтому его так любят технические писатели и разработчики.
Большинство современных редакторов поддерживают *GitHub-Flavored Markdown* (GFM) — расширение поверх оригинального CommonMark, в котором появились таблицы, чек-листы, блоки кода с указанием языка, автоссылки и зачёркнутый текст.
, python ) включают подсветку синтаксиса в большинстве рендереров.Используйте # для заголовков, * или _ для выделения, - для списков. Правая панель обновляется на лету.
Расставьте заголовки, блоки кода и таблицы, чтобы документ был логично разбит. У большинства редакторов есть горячие клавиши для базового форматирования (Ctrl+B, Ctrl+I).
Сравните живой предпросмотр с исходником. Если что-то отрисовалось не так, как вы ожидали, обычно дело в пропущенной пустой строке или в незакрытом блоке кода.
Скопируйте Markdown-исходник в свой README или возьмите готовый HTML и вставьте его в письмо, CMS — словом, туда, где Markdown не понимают.
Те 80% Markdown, которые понадобятся вам каждый день. Всё остальное гуглится за минуту. Спецификации: CommonMark и GitHub-Flavored Markdown.
| Элемент | Markdown | Результат |
|---|---|---|
| Заголовок 1 | # Title | Заголовок верхнего уровня |
| Заголовок 2 | ## Section | Заголовок раздела |
| Жирный | **strong** | **strong** |
| Курсив | *emphasis* или _emphasis_ | *emphasis* |
| Код в строке | code | code |
| Блок кода | Оберните код в тройные обратные кавычки, по желанию указав язык | Блок с подсветкой синтаксиса |
| Ссылка | `label` | Кликабельная ссылка |
| Картинка | `!alt` | Встроенное изображение |
| Список | - item | Маркированный список |
| Нумерованный список | 1. item | Нумерованный список |
| Чек-лист (GFM) | - [x] done | Отмеченный чекбокс |
| Таблица (GFM) | | a | b |\n|---|---|\n| 1 | 2 | | Таблица из двух колонок |
| Цитата | > quote | Цитата с отступом |
# Project Name
A short description in one or two sentences.
## Install
```bashnpm install project-name```
## Quick start
- Step 1- Step 2- Step 3Заголовок, краткое описание, команда установки в блоке кода и список шагов — это и есть скелет любого нормального README.
| Feature | Free | Pro ||---------|:----:|:---:|| Editor | ✓ | ✓ || Export | | ✓ |Колонки разделяются вертикальными чертами (|). Строка с дефисами задаёт колонки, а двоеточия : — выравнивание (по левому краю, по центру, по правому). В GFM-таблицах не нужно подгонять ширину колонок — важна только структура.
- [x] Draft the post- [x] Add screenshots- [ ] PublishGitHub отрисует это интерактивными чекбоксами в issues и pull request'ах. Удобно для контрольных списков прямо в документе и для лёгкого отслеживания задач.
# heading, **bold**, `link`) в готовый HTML. Главное его свойство — исходник остаётся читаемым человеком.marked, markdown-it или pandoc. В генераторах статических сайтов это происходит автоматически при сборке.<video>), но при этом документ становится завязан на конкретный HTML-вывод.