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