Настройка страницы
Отдельные страницы md-файлов можно настроить с помощью метаданных, добавленного в начало страницы.
---
icon: star
order: 100
---
# Пример
Текст демонстрация
Здесь могут хранится отдельно настройки каждой страницы.
Страница по умолчанию (главная страницы)
Доксиунм ищет страницы по умолчанию в корне проекта по следующему приоритету:
- default.md
- index.md
- readme.md
- welcome.md
Отдельный файл .yml с метаданными страницы
Все настройки можно не хранить на странице публикации, а вынести в отдельных файл, чтобы не смешивать markdown-файл с текстом и его настройки.
Например, если у нас есть файл Пример.md, то файл с метаданными будет называться Пример.yml, либо Пример.yaml.
Файл метаданных может иметь расширения: .yml или .yaml.
Добавление метаданных вверх на страницу .md или в отдельный файл .yml зависит только от ваших предпочтений. Оба метода дают одинаковый результат.
# Пример
Текст демонстрация
icon: star
order: 100
Если метаданные будут и на странице вверху и в отдельном файле, то программа выберет то, что на странице. Обе настройки метаданных одновременно использоваться не будут.
Настройки YML
icon
icon: Строка
В этой настройке задается шорткод из набора иконок Octicons.
icon: star
description
description: Строка
Пользовательское описание текущей страницы
description: Статья посвящена настройкам системы
order
order: string
Порядок сортировки. Может быть следующих видов:
- Число
- Версия (SemVer)
- Строка
order: 200
order: v1.5
date
date: Строка
Пользовательская дата публикации для этой страницы. Если не задана, то будет использована последняя дата изменения файла.
date: 2024-05-25
date: 2024-05-25T13:30
modified
modified: Строка
Пользовательская дата изменения публикации для этой страницы. Если не задана, то будет использована последняя дата изменения файла.
modified: 2024-05-25
modified: 2024-05-25T13:30
status
status: public|draft
Настройка указывает на видимость и доступность страницы. Состояние может быть: public, draft. По умолчанию, используется public.
| Значение | В результатах поиска | Описание |
|---|---|---|
public | + | Страница видима и доступна для всех и видна в главном меню навигации |
draft | - | Страница создана, но не будет включена в навигацию или результаты поиска. Полезно для обмена черновиком страницы перед публикацией. |