Участие в документации по документам GitHub
Узнайте, как команда GitHub Docs создает документацию и как вы можете внести свой вклад.
Рекомендуемая конфигурация
Сведения об участии в GitHub Docs
Вы можете внести свой вклад в содержимое документации GitHub несколькими способами.
Рекомендации по GitHub Docs
Следуйте этим рекомендациям, чтобы создать документацию, удобную и удобную для понимания.
Руководство по стилю
Следуйте этому руководству, чтобы убедиться, что документация GitHubостается согласованной и соответствует четким шаблонам, которые могут понять наши читатели.
Статьи
Документация по управление версиями
GitHub Docs использует интерфейсные операторы YAML и операторы liquid для поддержки нескольких версий GitHub с одним исходным подходом.
Изменение заголовка статьи
Если необходимо изменить название статьи, имя может потребоваться обновить в нескольких местах.
Использование frontmatter YAML
Интерфейс YAML можно использовать для определения управления версиями, добавления метаданных и управления макетом статей.
Использование Git на сайте GitHub Docs
Вы можете использовать Git в командной строке для фиксации изменений, а затем отправить их в репозиторий документации.
Использование Markdown и Liquid в документах GitHub
Вы можете использовать Markdown и Liquid для форматирования содержимого, создания повторно используемого содержимого и записи содержимого для различных версий в GitHub Docs.
Использование видео в документациях GitHub
В этом руководстве объясняется, как создавать видео, поддерживающие потребности пользователей в GitHub Docs.
Использование заполнителя TODOCS для выхода заметок
Заполнитель TODOCS можно использовать для указания работы, которая по-прежнему должна быть завершена.
Использование содержимого
Вы можете использовать содержимое linter для проверки ваших вкладов на наличие ошибок.
Концептуальный тип контента
Люди чаще всего используют концептуальное содержимое, когда они учатся о чем-то новом для них.
Отображение {начало}-{конец} {всего}