Примечание
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019
В этой статье описывается структура файлов и папок для подготовленных вики-сайтов и вики-сайтов, опубликованных в виде кода. Для обоих типов вики-сайта файлы хранятся в репозитории Git. Файлы могут включать страницы Markdown, код, изображения, вложения или другие артефакты. Чтобы установить последовательность презентаций файлов, Git добавляет специальный файл (.order) в каждую папку репозитория.
При создании проекта вики-сайт по умолчанию не создается. Вы можете подготовить вики-сайт, создать README или опубликовать код проекта в качестве вики-сайта.
Вы создаете вики-сайт с помощью пользовательского интерфейса Azure DevOps. Затем вы можете редактировать вики, используя URL-адрес пути репозитория Git.
Файлы репозитория и структура папок
Репозиторий Git для вики-сайта имеет два соглашения об именовании:
- Имя вики-репозитория —
<ProjectName>.wiki<ProjectName>это имя проекта. - Имя корневой ветви для вики-репозитория
wikiMain.
Вы управляете вики-репозиторием таким же образом, как и другие репозитории Git, определяя политики ветвей в wikiMain ветви. Вы также можете вносить изменения в локальную wikiMain ветвь и отправлять их непосредственно в удаленную ветвь без определения политик.
Репозиторий вики-сайта состоит из следующих файлов и папок:
- Файл для каждой страницы Markdown, расположенной на корневом уровне
- Файл с именем .order, расположенный на корневом уровне и в каждой вложенной папке
- Подпапка для каждой вики-страницы, имеющей подстраницы
- Папка с именем .attachments для хранения всех вложений, используемых в вики-сайте
Соглашения об именовании файлов
Имя файла для каждой вики-страницы соответствует названию вики-страницы. В имени файла дефис (-) представляет пробел в заголовке страницы. Например, заголовок страницы "Как внести вклад" соответствует имени файла How-to-contribute.md. Путь URL-адреса к вики-странице содержит имя файла. Например: https://github.com/ExampleWiki/How-To/How-to-contribute.md. Этот подход помогает гарантировать, что ссылки на закладки на страницу остаются нетронутыми по мере изменения вики-сайта с течением времени.
Каждая вики-страница соответствует файлу в репозитория вики-сайта Git. Следующие ограничения применяются к именам файлов страниц и размеру файла:
Имя файла. При выборе имени файла страницы помните, что полный путь к файлу должен составлять 235 символов или меньше. Полный путь к странице состоит из URL-адреса репозитория, пути к файлу страницы и имени файла страницы. Например:
https://github.com/ExampleWiki/Contributors/Code/How-to-add-code-to-the-project.md.Уникальность: имя файла страницы должно быть уникальным в папке в иерархии вики-репозитория. Имя чувствительно к регистру.
Специальные символы: имя файла страницы имеет ограничения на следующие специальные символы:
- Без символов элемента управления Юникода или суррогатных символов
- Нет печатных символов: косая черта
/, обратная косая черта\, хэш# - Нет символа точки
.в начале или конце имени
Размер файла: максимальный размер файла страницы составляет 18 МБ.
Размер файла вложения: максимальный размер любого вложения к файлу страницы составляет 19 МБ.
Разрешенные специальные символы
В имени файла страницы разрешено несколько специальных символов, таких как двоеточие : и дефис -. Например, файл Markdown можно назвать как часто задаваемые вопросы:0525 или руководство по настройке.
Это важно
Чтобы избежать ошибок в синтаксисе страницы и навигации в браузере, не используйте пробел ( ) в именах файлов страниц. Если вы назовете файлы страниц на основе заголовка страницы, замените все пробелы в заголовке страницы дефисом (-) в имени файла.
В следующей таблице перечислены специальные символы, разрешенные в именах файлов вики-страницы, и соответствующая строка в кодировке URI:
| Персонаж | Символ | Строка URI |
|---|---|---|
| Двоеточие | : |
%3A |
| Левая угловая скобка | < |
%3C |
| Правая угловая скобка | > |
%3E |
| Звездочка (подстановочный знак) | * |
%2A |
| Вопросительный знак | ? |
%3F |
| канал | | |
%7C |
| Дефис (тире) | - |
%2D |
| Двойная кавычка | " |
22 % |
Например, имя файла часто задаваемые вопросы:0525 закодировано как FAQ%3A0525.
Последовательность страниц и файл .order
Файл .order определяет последовательность вики-страниц. Git ищет этот файл в каждой папке, чтобы определить последовательность для представления файлов в этом расположении. По умолчанию последовательность страниц является алфавитным порядком (A–Z) по имени файла.
Определение пользовательской последовательности страниц
Если папка не имеет файла order , Git использует алфавитную последовательность по умолчанию.
Можно задать пользовательскую последовательность для любой папки, обновив файл order в папке, в том числе на корневом уровне.
В следующей визуализации показан пример таблицы содержания вики (TOC) и соответствующего файла .order, который создает оглавление.
Оглавление Вики отображается в веб-браузере
Файл .order определяет последовательность страниц TOC
Файл order изменяет последовательность с алфавитной на "Маркетинг", а затем на "Fabrikam Fiber".
Дополнительные сведения о том, как переупорядочить вики-страницы, см. в разделе Добавление, редактирование и изменение порядка вики-страниц.
Восстановление алфавитной последовательности
Если папка имеет настраиваемую последовательность, можно вернуть метод сортировки в алфавитный режим, выполнив следующие действия:
Скопируйте URL-адрес клона для вики-сайта и откройте его в браузере. Откроется репозиторий Git для вики-сайта.
Перейдите к файлу order, который вы хотите вернуть в предыдущее состояние, и удалите его. После удаления файла Git автоматически создает новый файл order для этого расположения. Новый файл использует последовательность по умолчанию.