Markdown - это легкий синтаксис форматирования текста, который превращает обычный текст в структурированные документы. Созданный в 2004 году Джоном Грубером, он теперь является стандартным форматом для документации, файлов README, сообщений в блогах и коммуникации разработчиков. В этом руководстве объясняется, что такое Markdown, почему люди используют его и как начать.
Что такое Markdown?
Markdown - это способ добавления форматирования к простому тексту с помощью простых знаков пунктуации. Вы пишете в текстовом редакторе, и Markdown передается в форматированный выход (HTML, PDF и т. Д.) процессором.
Например:
# This is a Heading
This is a **bold word** and this is *italic*.
- List item one
- List item twoОписание:
Это заголовок
Это ... смелое слово А это ... italic.
- Первый пункт списка
- Второй пункт списка
Форматирование живет в самом тексте нет скрытого XML, нет бинарного формата, нет собственного кодирования.
Почему был создан ПА__?
До Markdown веб-дизайнеры сталкивались с выбором: писать в сыром HTML (трудно и склонно к ошибкам) или использовать WYSIWYG-редактор, который производил беспорядочный код. Джон Грубер разработал Markdown для:
- Читаем как есть Даже без передачи,
**bold**ясно читается как акцент - Написать может любой Никакого специального программного обеспечения, просто текстовый редактор
- Конвертируемый в HTML Первичный формат вывода
Первоначальная спецификация сосредоточена на производстве чистой HTML. Но Markdown с тех пор распространился на десятки платформ и формат вывода.
Где используется Markdown?
Markdown повсюду в технологиях:
| Платформа | Что делает Markdown |
|---|---|
| GitHub | README, проблемы, запросы на вывод, вики |
| Notion | Содержание страниц и документы |
| Obsidian | Все записки в хранилище . |
| Вордпресс | Публикации через Markdown плагин |
| GitBook | Страницы документации |
| Отсталость / Раскол | Форматирование сообщений |
| Переполнение стека | Вопросы и ответы |
| Джекилл / Хьюго / Астро | Посты в блогах и статические страницы |
| Записки Юпитера | Ячейки документации |
Если вы пишете какой-либо технический контент, вы почти наверняка столкнулись с Markdown.
Markdown против Word: Основные различия
| Отношение | Word | Markdown |
|---|---|---|
| Формат | Двойной (.docx) | Простой текст (.md) |
| Переносимость | Требуется Word или совместимое приложение | Открывается в любом текстовом редакторе |
| Управление версиями | Трудно (бинарные различия) | Легко (отличия Git по строке) |
| Редактирование | Встроенное в приложение | Требуется Markdown рендер |
| Кривая обучения | WYSIWYG (без обучения) | Требует обучения синтаксису |
| Поддержка платформы | Экосистема Microsoft | Универсальные инструменты для разработчиков |
Если у вас есть Word документы, которые вы хотите преобразовать в Markdown, WordToMD Не записывается, не загружается.
Основной Markdown синтаксис
Вот наиболее распространенные элементы:
Заголовки
# Heading 1
## Heading 2
### Heading 3См. также: Markdown Руководство по заголовкам для полного ссылки.
Подчеркновение
**Bold text**
*Italic text*
~~Strikethrough~~Списки
- Unordered item
- Another item
- Nested item
1. First
2. Second
3. ThirdСсылки
[Link text](https://example.com)Изображения
Код
Inline: `code snippet`
Block:
```python
print("Hello, Markdown!")
See [Markdown Code Blocks Guide](/blog/markdown-code-blocks-guide).
### Tables
```markdown
| Name | Role |
|---|---|
| Alice | Developer |
| Bob | Designer |См. также: Markdown Таблицы: полное руководство.
Блок-квоты
> This is a blockquote.
> It can span multiple lines.Markdown Ароматы
Markdown не является единым стандартом существует несколько вариантов:
- CommonMark строгая и однозначная спецификация
- GitHub Ароматизированные Markdown (GFM) CommonMark + таблицы, списки задач, прокладки, автоссылки
- Многознаковое загрузка Добавляет сноски, цитаты, метаданные
- Я не знаю, что это значит. Наиболее богатый на функции, используемый преобразователем Pandoc
Большинство платформ поддерживают по крайней мере CommonMark. GitHub, Obsidian и GitBook используют GFM. Полная справка см. Markdown Синтаксис краткая памятка.
Как писать Markdown
Вам не нужно специальное программное обеспечение. Варианты включают:
- Код VS Бесплатный, мощный редактор с встроенным Markdown предварительным просмотром
- Obsidian Markdown приложение для записи записей с графическим просмотром
- Типора WYSIWYG Markdown редактор
- iA Режиссер Концентрированная среда для написания
- Любой простой текстовый редактор Блокнот, TextEdit, vim, emacs
Преобразование между Markdown и другими форматами
Если у вас есть Word документы для преобразования в Markdown, WordToMD делает это за считанные секунды совершенно бесплатно, без загрузки файлов.
Для обратного (Markdown в Word или PDF), такие инструменты, как Pandoc обрабатывают эту конверсию. См. также: Pandoc Word до Markdown для инструкций по установке.
FAQ
Язык программирования Markdown? - Нет, я не знаю. Markdown - это язык разметки он описывает форматирование, а не логику или вычисления.
Могу ли я использовать Markdown в Microsoft Word? Word не представляет Markdown нативным образом, но есть Word дополнения, которые добавляют Markdown поддержку. В качестве альтернативы, преобразовать Word в Markdown с WordToMD и использовать Markdown редактора.
Хорошо ли Markdown для длинных документов? Да, с хорошей структурой направления. Очень длинные документы получают выгоду от разделения на несколько файлов (как в GitBook или Obsidian хранилищах).
Какое расширение файла использует Markdown?
.md это стандарт. .markdown также действительна. Некоторые платформы используют .mdx для Markdown с компонентами JSX (React).
Заключение
Markdown - это простой, мощный формат, который стал лингва франка технического письма. Он читается в виде простого текста, превосходно отображается и работает со всеми основными инструментами разработчиков. Если вы новичок в этом, начните с Markdown Синтаксис краткая памятка и попробуйте конвертировать свой первый Word документ на WordToMD.