Skip to main content

Добавление и редактирование вики-страниц

Вы можете добавлять и изменять страницы вики-сайта непосредственно в GitHub или локально с помощью командной строки.

Кто эту функцию можно использовать?

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

Добавление вики-страниц

  1. На GitHub.comперейдите на главную страницу репозитория.

  2. Под именем репозитория щелкните Wiki.

    Снимок экрана: меню в репозитории. Параметр "Вики- сайт" описан в темно-оранжевый.

  3. В правом верхнем углу страницы щелкните Новая страница.

  4. При необходимости для записи в формате, отличном от Markdown, используйте раскрывающийся список "Режим редактирования" для выбора другого формата.

    Снимок экрана: страница "Создание новой страницы". Раскрывающийся список "Режим редактирования" описан в темно-оранжевый.

  5. Используйте текстовый редактор для добавления содержимого страницы.

  6. В поле "Изменить сообщение" введите сообщение фиксации, описывающее добавляемый файл.

  7. Чтобы зафиксировать изменения на вики-сайте, нажмите Сохранить страницу.

Изменение вики-страниц

  1. На GitHub.comперейдите на главную страницу репозитория.

  2. Под именем репозитория щелкните Wiki.

    Снимок экрана: меню в репозитории. Параметр "Вики- сайт" описан в темно-оранжевый.

  3. Используя вики-боковую панель справа, перейдите на страницу, которую вы хотите изменить. В правом верхнем углу страницы щелкните Изменить.

  4. В текстовом редакторе измените содержимое страницы.

  5. В поле "Изменить сообщение" введите сообщение фиксации, описывающее добавляемый файл.

  6. Чтобы зафиксировать изменения на вики-сайте, нажмите Сохранить страницу.

Добавление или изменение вики-страниц на локальном компьютере

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

Клонирование вики-сайтов на компьютер

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

$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.wiki.git
# Clones the wiki locally

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

Сведения об именах файлов для вики-сайтов

Имя файла определяет название вики-страницы, а расширение файла — то, как отображается ее содержимое.

Вики-сайты используют нашу библиотеку разметки с открытым кодом для преобразования разметки. Она определяет то, какой преобразователь следует использовать для того или иного расширения имени файла. Например, файл имеет имя foo.md или foo.markdown, вики-сайт будет использовать преобразователь Markdown, а для файла с именем foo.textile будет применяться преобразователь Textile.

Не используйте следующие символы в заголовках вики-страниц: \ / : * ? " < > | Пользователи определенных операционных систем не смогут работать с именами файлов, содержащими эти символы. При написании содержимого используйте язык разметки, соответствующий расширению, иначе содержимое будет отрисовываться неправильно.