Написание документов GitHub
Узнайте о написании данных GitHub Docs.
Рекомендации по GitHub Docs
Следуйте этим рекомендациям, чтобы создать документацию, удобную и удобную для понимания.
О философии документации GitHub
Наша философия документации описывает, какие материалы мы создадим и как мы создадим его.
Принципы проектирования содержимого
Мы совместно используем эти принципы для разработки и создания лучшего содержимого для пользователей, использующих GitHub.
Написание содержимого для перевода
Наша документация переведена на несколько языков. Как мы подходим к написанию документации по английскому языку, значительно улучшили качество этих переводов.
Создание доступных для поиска содержимого
Следуйте этим рекомендациям по SEO, чтобы помочь пользователям найти документацию GitHub с помощью поисковых систем.
Документация по управление версиями
GitHub Docs использует интерфейсные операторы YAML и операторы liquid для поддержки нескольких версий GitHub с одним исходным подходом.
Использование Markdown и Liquid в документах GitHub
Вы можете использовать Markdown и Liquid для форматирования содержимого, создания повторно используемого содержимого и записи содержимого для различных версий в GitHub Docs.
Использование frontmatter YAML
Интерфейс YAML можно использовать для определения управления версиями, добавления метаданных и управления макетом статей.
Использование видео в документациях GitHub
В этом руководстве объясняется, как создавать видео, поддерживающие потребности пользователей в GitHub Docs.
Создание повторно используемых содержимого
Вы можете создать повторно используемый контент, на который можно ссылаться в нескольких файлах содержимого.
Создание снимков экрана
Вы можете помочь пользователям находить элементы пользовательского интерфейса, которые трудно найти, добавив снимки экрана в GitHub Docs.
Создание схем для GitHub Docs
В этом руководстве объясняется, когда и как создавать схемы для GitHub Docs.
Создание переключателей инструментов в статьях
Вы можете использовать переключатель инструментов, чтобы показать, как выполнять задачи с помощью определенных средств.
Настройка перенаправлений
Если название, версия или расположение статьи изменены, можно создать перенаправление к текущему содержимому.
Изменение заголовка статьи
Если необходимо изменить название статьи, имя может потребоваться обновить в нескольких местах.
Примеры кода аннотирования
Более длинные примеры кода можно узнать, как они работают и как люди могут настраивать их для других использования.
Шаблоны
В этой статье содержатся начальные шаблоны для различных типов контента, используемых в GitHub Docs.