Skip to main content

Enterprise Server 3.20 в настоящее время доступен в качестве кандидата на выпуск.

О написании и форматировании на GitHub

GitHub сочетает синтаксис для форматирования текста под названием GitHub Flavored Markdown с несколькими уникальными функциями письма.

Кто может использовать эту функцию?

Markdown можно использовать в веб-интерфейсе GitHub .

Добавив в него ряд специальных функций, мы получили инструмент GitHub Flavored Markdown, который используется для форматирования художественного текста и кода на нашем сайте.

Вы также можете взаимодействовать с другими пользователями в запросах на вытягивание и проблемы с помощью таких функций, как @-mentions, например, ссылки на вопросы и ссылки на PR, а также эмодзи. Дополнительные сведения см. в разделе Базовый синтаксис написания и форматирования.

Панель инструментов для форматирования текста

Каждое поле комментариев в GitHub содержит панель инструментов форматирования текста, которая позволяет отформатировать текст без изучения синтаксиса Markdown. Помимо форматирования Markdown, например полужирных и курсивных стилей и создания заголовков, ссылок и списков, панель инструментов включает в себя функции GitHub, такие как @-mentionsсписки задач и ссылки на проблемы и запросы на вытягивание.

Включение шрифтов фиксированной ширины в редакторе

Вы можете включить шрифт фиксированной ширины в каждом поле комментариев на GitHub. Каждый символ в фиксированной ширине или монопространстве шрифт занимает одинаковое горизонтальное пространство. Это упрощает редактирование расширенных структур Markdown, таких как таблицы и фрагменты кода.

Снимок экрана: комментарий GitHub с примером таблицы Markdown с описанием двух команд Git. Все буквы в таблице имеют одинаковую визуальную ширину.

  1. В правом верхнем углу любой страницы на GitHubщелкните рисунок профиля, а затем выберите октикона "шестеренка" aria-hidden="true" aria-label="gear" %} Settings.

  2. На левой боковой панели щелкните октикона "кисть" aria-hidden="true" aria-label="paintbrush" %} Внешний вид.

  3. В разделе "Параметры шрифтов в редакторе Markdown" выберите Использовать шрифт фиксированной ширины (моноширинный) при редактировании в Markdown.

           ![Снимок экрана: параметры пользователя GitHub для предпочтений Markdown. Флажок для использования шрифта исправлений ширины в Markdown установлен и описан в темно-оранжевый цвет.](/assets/images/help/writing/enable-fixed-width.png)
    

Дополнительные материалы

  •         [Спецификация GitHub Flavored Markdown](https://github.github.com/gfm/)
    
  •         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
    
  •         [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting)
    
  •         [AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)