Skip to main content

Сведения о вики-сайтах

Можно разместить на вики-сайте документацию по репозиторию, чтобы другим пользователям было удобнее использовать его и участвовать в работе над проектом.

Вики-сайты доступны в общедоступных репозиториях при использовании GitHub Free и GitHub Free для организаций, а также в общедоступных и частных репозиториях при использовании GitHub Pro, GitHub Team, GitHub Enterprise Cloud и GitHub Enterprise Server. Дополнительные сведения см. в разделе Продукты GitHub.

Каждый репозиторий в GitHub.com имеет раздел для размещения документации, называемый вики-сайтом. Вы можете использовать вики-сайт репозитория для предоставления общего доступа к информации о проекте в полном формате, например сведения о разработке проекта, о его использовании и ключевых принципах. Файл сведений быстро сообщает о возможностях проекта, и кроме того, вы можете использовать вики-сайт для предоставления дополнительной документации. Дополнительные сведения см. в статье О файлах README.

С помощью вики-сайтов вы можете писать содержимое так же, как и в любом другом расположении в GitHub. Дополнительные сведения см. в разделе Начало работы с написанием и форматированием в GitHub. Мы используем библиотеку Markup с открытым кодом для преобразования различных форматов в HTML, поэтому вы можете писать код в Markdown или в любом другом поддерживаемом формате.

Вы можете использовать Markdown для добавления отрисованных математических выражений, диаграмм, сопоставлений и трехмерных моделей на вики-страницы. Дополнительные сведения о создании отрисованных математических выражений см. в на странице Написание математических выражений. Дополнительные сведения о создании диаграмм, сопоставлений и трехмерных моделей см. на странице Создание диаграмм.

Если вы создаете вики-сайт в общедоступном репозитории, вики-сайт будет доступен public. Если вы создаете вики-сайт в частном репозитории , доступ к нему будут иметь только пользователи с доступом к репозиторию. Дополнительные сведения см. в разделе Настройка видимости репозитория.

Вы можете редактировать вики-сайты непосредственно в GitHubили изменить вики-файлы локально. По умолчанию только пользователи с доступом на запись в репозиторий могут вносить изменения в вики-сайты, хотя вы можете разрешить всем пользователям GitHub.com вносить свой вклад в вики-сайт в общедоступный репозиторий. Дополнительные сведения см. в разделе "Изменение разрешений для доступа к вики-сайтам".

Примечание. Поисковые системы не будут индексировать содержимое вики-сайтов. Чтобы содержимое индексировалось поисковыми системами, можно использовать GitHub Pages в общедоступном репозитории.

Дополнительные материалы