Repolode
Предложить
guodongxiaren

guodongxiaren/README

Справочник по синтаксису Markdown и файл для проверки отображения GitHub Flavored Markdown (GFM) в README, issues и вики.

Открыть на GitHubСайт
Звёзды
7,064
Форки
7,039
Открытые issues
55
Последний коммит
12 месяцев назад

Что это?

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

В каждом разделе исходный синтаксис сопоставлен с результатом отображения, поэтому можно точно увидеть, как будет выглядеть тот или иной элемент. Те же возможности GFM доступны в README, issues и вики на GitHub, поэтому документ удобно использовать как краткий справочник при написании документации проекта.

Ключевые возможности

  • 01Рассматриваются заголовки, выделение текста, зачёркивание и вложенные списки.
  • 02Показан синтаксис изображений и ссылок, в том числе ссылок с определением в отдельном блоке.
  • 03Продемонстрированы блоки кода с ограждением и подсветкой синтаксиса.
  • 04Есть выравнивание в таблицах, блоки с уведомлениями и подсветка diff.
  • 05Описаны HTML-приёмы, например сворачиваемые разделы и центрирование содержимого.

Сценарии использования

  • Подсмотреть синтаксис GFM при написании README или issue.
  • Разобраться, как оформлять таблицы, списки задач и блоки с уведомлениями на GitHub.
  • Проверить, как задаются сворачиваемые разделы или центрированные блоки с помощью HTML.

Что важно знать

  • Это справочник по синтаксису Markdown и тестовый файл, а не устанавливаемое программное обеспечение.

В подборках

Генераторы статических сайтов и инструменты для документации

Темы

#markdown#gfm#readme#documentation#github#flavored

Частые вопросы

Что такое README?
Справочник по синтаксису Markdown и файл для проверки отображения GitHub Flavored Markdown (GFM) в README, issues и вики. Практическое руководство по GitHub Flavored Markdown — расширенному синтаксису Markdown, который используется на GitHub. В нём рассматриваются заголовки, оформление текста, изображения, ссылки, списки, цитаты, подсветка кода, таблицы, блоки с уведомлениями, эмодзи, diff-блоки и распространённые HTML-теги, например для сворачиваемых разделов и центрирования содержимого.
README можно использовать бесплатно? Какая у него лицензия?
README распространяется с открытым исходным кодом под лицензией Unlicense. Перед использованием в коммерческих продуктах проверьте условия лицензии.
README всё ещё поддерживается?
Нет коммитов больше 6 месяцев. Последний коммит в README — 24 нояб. 2025 г..
Для чего можно использовать README?
Подсмотреть синтаксис GFM при написании README или issue. Разобраться, как оформлять таблицы, списки задач и блоки с уведомлениями на GitHub. Проверить, как задаются сворачиваемые разделы или центрированные блоки с помощью HTML.
Где скачать README?
Исходный код и инструкции по установке — на GitHub: https://github.com/guodongxiaren/README

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

badges / shields

Shields.io — сервис и NPM-библиотека для создания компактных SVG- и растровых статусных бейджей для README-файлов и веб-страниц.

DevOps и облака#badge#svg#status-badge
27,4 тыс.+23 за неделю5,6 тыс.JavaScriptApache-2.0Активно поддерживаетсяОбновлён 19 часов назад

wei / socialify

Создаёт изображения для соцсетей и превью GitHub-репозиториев с актуальной статистикой, логотипами, шрифтами и фоновыми узорами.

Инструменты разработчика#github#badges#social-image
2,2 тыс.123TypeScriptMITОбновлён 10 дней назад