Каждый репозиторий в GitHub.com имеет раздел для размещения документации, называемый вики-сайтом. Вы можете использовать вики-сайт репозитория для предоставления общего доступа к информации о проекте в полном формате, например сведения о разработке проекта, о его использовании и ключевых принципах. Файл сведений быстро сообщает о возможностях проекта, и кроме того, вы можете использовать вики-сайт для предоставления дополнительной документации. Дополнительные сведения см. в разделе Сведения о файлах сведений.
С помощью вики-сайтов вы можете писать содержимое так же, как и в любом другом расположении в GitHub. Дополнительные сведения см. в разделе Getting started with writing and formatting on GitHub (Основные сведения о подготовке материалов и форматировании на GitHub). Мы используем библиотеку Markup с открытым кодом для преобразования различных форматов в HTML, поэтому вы можете писать код в Markdown или в любом другом поддерживаемом формате.
Вы можете использовать Markdown для добавления отрисованных математических выражений, диаграмм, сопоставлений и трехмерных моделей на вики-страницы. Дополнительные сведения о создании отображаемых математических выражений см. в разделе Написание математических выражений. Дополнительные сведения о создании схем, карт и трехмерных моделей см. в разделе Создание схем.
Если вы создаете вики-сайт в общедоступном репозитории, вики-сайт будет доступен public. Если вы создаете вики-сайт в частном репозитории , доступ к нему будут иметь только пользователи с доступом к репозиторию. Дополнительные сведения см. в разделе Настройка видимости репозитория.
Вы можете редактировать вики-сайты непосредственно в GitHubили изменить вики-файлы локально. По умолчанию только пользователи с доступом на запись в репозиторий могут вносить изменения в вики-сайты, хотя вы можете разрешить всем пользователям GitHub.com вносить свой вклад в вики-сайт в общедоступный репозиторий. Дополнительные сведения см. в разделе Изменение прав доступа для вики-сайтов.
Примечание. Поисковые системы не будут индексировать содержимое вики-сайтов. Чтобы содержимое индексировалось поисковыми системами, можно использовать GitHub Pages в общедоступном репозитории.