Эта версия GitHub Enterprise Server будет прекращена 2026-06-02. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, повышения безопасности и новых функций выполните обновление до последней версии GitHub Enterprise Server. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.

Участие в документации по документам GitHub

Узнайте, как GitHub Docs команда создаёт документацию и как вы можете внести свой вклад.

Обзор Быстрое начало

Рекомендуемая конфигурация

Сведения об участии в GitHub Docs

Вы можете внести свой вклад в содержимое документации GitHub несколькими способами.

Рекомендации по GitHub Docs

Следуйте этим рекомендациям, чтобы создать документацию, удобную и удобную для понимания.

Руководство по стилю

Следуйте этому руководству, чтобы GitHubдокументация оставалась последовательной и следовала чётким шаблонам, понятным нашим читателям.

Статьи

Write and format content

Документация по управление версиями

GitHub Docs использует интерфейсные операторы YAML и операторы liquid для поддержки нескольких версий GitHub с одним исходным подходом.
Write and format content

Изменение заголовка статьи

Если необходимо изменить название статьи, имя может потребоваться обновить в нескольких местах.
Write and format content

Использование frontmatter YAML

Интерфейс YAML можно использовать для определения управления версиями, добавления метаданных и управления макетом статей.
Get set up to contribute

Использование Git на сайте GitHub Docs

Вы можете использовать Git в командной строке для фиксации изменений, а затем отправить их в репозиторий документации.
Write and format content

Использование Markdown и Liquid в документах GitHub

Вы можете использовать Markdown и Liquid для форматирования содержимого, создания повторно используемого содержимого и записи содержимого для различных версий в GitHub Docs.
Get set up to contribute

Использование заполнителя TODOCS для выхода заметок

Заполнитель TODOCS можно использовать для указания работы, которая по-прежнему должна быть завершена.
Get set up to contribute

Использование содержимого

Вы можете использовать содержимое linter для проверки ваших вкладов на наличие ошибок.
Understand the GitHub approach to docs

Написание содержимого для перевода

Наша документация переведена на несколько языков. Как мы подходим к написанию документации по английскому языку, значительно улучшили качество этих переводов.
Write and format content

Настройка перенаправлений

Если название, версия или расположение статьи изменены, можно создать перенаправление к текущему содержимому.
Отображение {начало}-{конец} {всего}