Учебник по Markdown

Markdown — это легковесный язык разметки, который позволяет людям писать документы, используя простой текстовый формат, удобный для чтения и написания.

Язык Markdown был создан Джоном Грубером в 2004 году.

Философия дизайна Markdown — "легко читать и писать", позволяющая людям писать структурированные документы, используя простой текстовый формат.

Документы, написанные в Markdown, можно экспортировать в несколько форматов, таких как HTML, Word, изображения, PDF и Epub.

Расширение файла для документов, написанных в Markdown, — это.md, .markdown。

Основные возможности Markdown включают:

Простота: для представления форматирования используются интуитивные символы, например, используйте#для заголовков, и используйте*для элементов списка. Эти символы визуально передают своё значение и остаются легко читаемыми даже без рендеринга.

Читаемость: Даже документы Markdown в виде обычного текста могут наглядно отображать структуру и иерархию документа. Читатели могут понять, как организовано содержимое, без необходимости в специализированном программном обеспечении.

Переносимость: Файлы Markdown представляют собой простой текстовый формат, их можно открывать и редактировать в любом текстовом редакторе, не завися от конкретного программного обеспечения или операционной системы.

Конвертируемость: Можно легко преобразовать в HTML, PDF, документы Word и другие форматы, чтобы удовлетворить различные потребности публикации.

Концепция облегчённого языка разметки

Язык разметки — это язык, который использует специальные символы для описания структуры и форматирования документа. Традиционные языки разметки, такие как HTML, мощны, но имеют сложный синтаксис, тогда как легковесные языки разметки упрощают этот процесс.

По сравнению с HTML, преимущества Markdown таковы:

  • Низкая стоимость обучения; базовый синтаксис можно освоить за несколько минут
  • Высокая эффективность написания; не нужно вводить сложные теги
  • Фокус на содержании, а не на деталях форматирования
  • Совместимость с системами контроля версий, что упрощает совместную работу и отслеживание изменений

Связь между Markdown и HTML

Markdown не является заменой HTML, а представляет собой упрощённую версию HTML. Фактически конечная цель Markdown — быть преобразованным в HTML. Взаимосвязь между ними можно понять так:

Markdown 源码 → 解析器 → HTML 输出 → 浏览器渲染

Например, когда вы пишете:

# This is a heading

Это будет преобразовано в:

<h1>这是一个标题</h1>

Важно, что вы можете напрямую использовать HTML-теги в Markdown, что обеспечивает гибкость для сложного форматирования. Когда базовый синтаксис Markdown не может удовлетворить ваши потребности, вы можете встроить HTML-код для достижения определённых эффектов.

Почему стоит выбрать Markdown

Повышение эффективности написания: Не нужно часто использовать мышь для форматирования, сохраняется непрерывность мышления. Авторы могут сосредоточиться на создании контента, не отвлекаясь на проблемы форматирования.

Снижает порог обучения: По сравнению с языками разметки, такими как LaTeX и HTML, синтаксис Markdown чрезвычайно прост; большинство людей может освоить базовое использование в течение часа.

Широкая совместимость: Почти все современные текстовые редакторы, редакторы кода и приложения для заметок поддерживают Markdown. От простого Notepad до профессиональных IDE — Markdown можно найти повсюду.

Удобство для контроля версий: Поскольку это формат простого текста, файлы Markdown хорошо работают с системами контроля версий, такими как Git, что позволяет легко отслеживать историю изменений документа и сотрудничать в командах.

Адаптивность к будущему: Даже если конкретное программное обеспечение или платформа исчезнет, файлы Markdown как простой текст всё равно можно открыть и редактировать, что обеспечивает долгосрочную доступность содержимого.

Сценарии применения Markdown

Написание технической документации

В области разработки программного обеспечения Markdown стал стандартным форматом для технической документации. Он особенно подходит для:

  • Документация API: Чёткая иерархия заголовков и отображение блоков кода делают описания API одновременно профессиональными и удобочитаемыми. Многие инструменты генерации документации API (например, Swagger) поддерживают описания в формате Markdown.

  • Описание проекта: От руководств по установке до пользовательских руководств Markdown может эффективно организовывать техническую информацию. Примеры кода, файлы конфигурации и операции командной строки могут быть должным образом отображены.

  • Стандарты разработки: Командные стандарты кодирования, руководства по дизайну, рабочие процессы и т. д. можно записывать в Markdown для удобства обращения и обновления участниками команды.

Создание постов в блоге

Большинство современных блог-платформ и генераторов статических сайтов поддерживают Markdown:

  • Управление контентом: Блогеры могут сосредоточиться на создании контента, не беспокоясь о сложном HTML-кодировании. Форматирование статей выполняется с помощью простых маркеров.

  • Миграция между платформами: Статьи, написанные в Markdown, можно легко переносить между разными платформами, не оказываясь привязанными к форматам конкретной платформы.

  • Написание офлайн: Статьи можно писать офлайн в любом текстовом редакторе, а затем публиковать пакетами, что повышает гибкость написания.

Файл README на GitHub

Платформа GitHub широко использует Markdown, особенно для файлов README проектов:

  • Введение в проект: Четко представляет ключевую информацию, такую как назначение проекта, возможности и использование.

  • Руководство по установке: Предоставляет подробные шаги установки и настройки через блоки кода и списки.

  • Руководство по участию: Объясняет, как участвовать в разработке проекта, включая стандарты кода, процессы отправки и т. д.

  • Отслеживание проблем: В Issues и Pull Requests разработчики используют Markdown, чтобы описывать проблемы и предлагать решения.

Ведение заметок и управление знаниями

Markdown становится предпочтительным форматом для цифровых заметок:

  • Учебные заметки: Поддерживает различные типы контента, такие как математические формулы, подсветка кода и диаграммы, что подходит для технического обучения и организации знаний.

  • Заметки о встречах: Чёткая структура заголовков и формат списков делают ключевые моменты встречи понятными с первого взгляда.

  • Создание базы знаний: Предприятия и частные лица используют Markdown для создания баз знаний, организуя информацию с помощью ссылок и тегов.

Онлайн-платформы для письма

Всё больше и больше платформ для письма начинают поддерживать Markdown:

  • GitHub, Jianshu, Zhihu: Редакторы на этих платформах поддерживают синтаксис Markdown, позволяя авторам быстро форматировать статьи.

  • GitBook、Notion: Профессиональные платформы для документов и заметок, которые нативно поддерживают Markdown и предоставляют мощные возможности организации и совместной работы.

  • Генераторы статических блогов: Инструменты, такие как Jekyll, Hugo и Hexo, позволяют пользователям создавать профессиональные сайты с помощью Markdown.

Полезные книги

"Удивительный Markdown":

Другие расширения