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