Back

Предпросмотр Markdown

Markdown — это лёгкий язык разметки для создания форматированного текста с помощью синтаксиса обычного текста. Популярен для документации, файлов README и ведения заметок, отображается в HTML для просмотра. Этот инструмент отображает предпросмотр Markdown с рендерингом в реальном времени, извлекает структуру документа (заголовки, ссылки, изображения) и может конвертировать в HTML.

Спецификации

Типичные сценарии использования

  • Предпросмотр файлов README.md перед коммитом
  • Проверка форматирования документации
  • Извлечение всех ссылок из документа для валидации
  • Конвертация Markdown в HTML для встраивания
  • Анализ структуры и навигации документа

Возможности

  • Предпросмотр в реальном времени с рендерингом HTML
  • Извлечение структуры документа (заголовки как оглавление)
  • Список всех ссылок и изображений в документе
  • Обнаружение и отображение блоков кода с указанием языка
  • Разбор frontmatter (метаданные YAML)
  • Конвертация в чистый HTML-вывод
  • Статистика по количеству слов и символов

Примеры

README с функциями

Попробовать →

Типичный README проекта с заголовками, списками и кодом.

# My Project

A brief description of what this project does.

## Installation

```bash
npm install my-project
```

## Features

- **Fast** - Optimized for speed
- **Simple** - Easy to use API
- **Flexible** - Works with any framework

## Links

- [Documentation](https://docs.example.com)
- [GitHub](https://github.com/example/project)

Советы

  • Используйте # для заголовков (# H1, ## H2, ### H3 и т.д.).
  • Блоки кода используют тройные обратные кавычки с необязательным идентификатором языка.
  • Ссылки используют синтаксис [текст](url); изображения — ![alt](url).
  • Frontmatter между строками --- может содержать метаданные YAML.

Описание Предпросмотр Markdown

Markdown — это лёгкий язык разметки, созданный Джоном Грубером в 2004 году, спроектированный для чтения как обычный текст и чистой конвертации в HTML. Его синтаксис использует знаки пунктуации, визуально предполагающие форматирование: # для заголовков, * для выделения, - для списков и обратные кавычки для кода. Файлы Markdown остаются полезными даже без рендеринга, что объясняет доминирование формата в документации, файлах README и технической документации.

Спецификация CommonMark (2014) устранила многочисленные неоднозначности оригинального Markdown. CommonMark точно определяет обработку пограничных случаев, и большинство современных парсеров его реализуют. GitHub Flavored Markdown (GFM) расширяет CommonMark таблицами, списками задач, зачёркиванием, автоссылками URL и огороженными блоками кода с подсветкой синтаксиса.

GFM является стандартом де-факто для файлов README, описаний пул-реквестов, комментариев к задачам и сайтов документации. Большинство платформ документации (Notion, Docusaurus, MkDocs, GitBook) поддерживают GFM или его расширение.

Frontmatter — распространённое соглашение для добавления структурированных метаданных к файлам Markdown. Блок YAML, ограниченный строками --- в начале файла, может содержать заголовок, дату, автора и теги, используемые генераторами статических сайтов (Astro, Hugo, Jekyll, Next.js) для построения навигации и макетов страниц.

На практике «Markdown» почти всегда означает CommonMark или GFM. Оригинальная спецификация Markdown оставила многие пограничные случаи неопределёнными, и CommonMark разрешил эти неоднозначности строгой спецификацией. GFM расширяет CommonMark таблицами, списками задач, зачёркиванием и автоссылками URL. При оценке парсера или рендерера Markdown проверка его совместимости с CommonMark является надёжным показателем качества обработки пограничных случаев.

Таблицы в GFM используют вертикальные черты (|) для разделения столбцов и дефисы (-) для разделительной строки заголовка. Выравнивание столбцов контролируется двоеточиями в разделителе: :--- для выравнивания по левому краю, :---: для центрирования и ---: для выравнивания по правому краю. Таблицы — расширение GFM и не являются частью оригинального синтаксиса Markdown. Frontmatter, ограниченный строками --- в самом начале файла, — это блок метаданных YAML, используемый генераторами статических сайтов для метаданных страницы: заголовка, даты, макета и тегов. GitHub отображает frontmatter как таблицу в начале файла, хотя не все рендереры его обрабатывают.

Огороженные блоки кода используют тройные обратные кавычки с необязательным идентификатором языка после открывающих — например, строка с тремя обратными кавычками, за которыми следует "javascript", начинает блок JavaScript с подсветкой синтаксиса. Доступные идентификаторы языков зависят от платформы рендеринга. Отступ кода на четыре пробела также создаёт блок кода, но без возможности указать язык для подсветки.

← Вернуться ко всем инструментам