Начало работы

Организация файлов

Сначала система собирает все ваши файлы Markdown и конфигурации из каталога pages, а затем генерирует "информацию о карте страниц" вашего сайта для отображения таких элементов, как навигационная панель и боковая панель ниже:

Структура файлов

Структура файлов имеет следующий вид: {категория}/{название-файла}.{язык}.mdx.

Доступные языки:

• ru - Русский
• en - Английский
• uk - Украинский

Поведение по умолчанию

По умолчанию карта страниц содержит все имена файлов .md и .mdx и структуру каталогов, отсортированные в алфавитном порядке. Затем система будет использовать пакет title (opens in a new tab), чтобы получить отформатированные имена страниц из имен файлов.

Например, если у вас есть следующая структура:

pages/
  contact.md
  index.mdx
  about/
    legal.md
    index.mdx

Разрешенная карта страниц будет выглядеть следующим образом (обратите внимание, что все имена были отсортированы в алфавитном порядке):

[
  {
    "name": "About",
    "children": [{ "name": "Index" }, { "name": "Legal" }]
  },
  { "name": "Contact" },
  { "name": "Index" }
]

И глобальная карта страниц будет объединена с каждой страницей Документации. Затем настроенная тема будет отображать фактический пользовательский интерфейс с помощью этой карты страниц.

Конфигурация _meta.json

Очень часто требуется настроить заголовок каждой страницы, а не просто использовать имя файла. Например, иметь страницу с заголовком "Index" не имеет смысла, вместо этого стоит использовать заголовок "Home".

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

pages/
  _meta.json
  contact.md
  index.mdx
  about/
    _meta.json
    legal.md
    index.mdx

И вы можете поместить следующий код в файл pages/_meta.json:

{
  "index": "My Homepage",
  "contact": "Contact Us",
  "about": "About Us"
}

Он сообщает системе порядок каждой страницы и правильный заголовок. Кроме того, вы можете сделать это с помощью title и добавить в него другие конфигурации:

{
  "index": "My Homepage",
  "contact": "Contact Us",
  "about": {
    "title": "About Us",
    "...дополнительные конфигурации...": "..."
  }
}

Дополнительные конфигурации передаются в тему в качестве дополнительной информации. Для получения дополнительной информации ознакомьтесь с соответствующими страницами.