Документирование проекта с помощью вики-сайтов
Вы можете использовать вики-сайт для предоставления подробной информации о проекте.
Кто может использовать эту функцию?
Wikis are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see GitHub’s plans.
Сведения о вики-сайтах
Можно разместить на вики-сайте документацию по репозиторию, чтобы другим пользователям было удобнее использовать его и участвовать в работе над проектом.
Добавление и редактирование вики-страниц
Вы можете добавлять и изменять страницы вики-сайта непосредственно в GitHub или локально с помощью командной строки.
Создание нижнего колонтитула или боковой панели для вики-сайта
Вы можете добавить настраиваемую боковую панель или нижний колонтитул в вики-сайт, чтобы предоставить читателям дополнительную контекстную информацию.
Редактирование содержимого вики-сайта
Вы можете добавлять изображения и ссылки на содержимое в вики-сайте и использовать некоторые поддерживаемые форматы MediaWiki.
Просмотр истории изменений вики-сайта
Так как вики-сайты являются репозиториями Git, каждое изменение, которое вы вносите, будет фиксацией, которую можно просмотреть.
Изменение прав доступа для вики-сайтов
Только участники совместной работы репозитория могут редактировать вики-сайт общедоступный репозиторий по умолчанию, но вы можете разрешить любому пользователю с учетной записью GitHub.com редактировать вики-сайт.
Отключение вики-сайтов
Можно отключить вики-сайт своего репозитория.