Руководство пользователя

Полное руководство по работе с движком документации.

Создание страниц

Базовая структура

Каждая страница документации - это файл Markdown в папке docs/: `markdown --- title: Название страницы description: Краткое описание ---

Основной заголовок

Ваш контент... `

Front Matter

Front Matter (метаданные) указываются в начале файла между ---:
  • title - заголовок страницы (отображается в браузере)
  • description - описание для SEO
  • Можно добавлять свои поля

Синтаксис Markdown

Заголовки

`markdown

H1 Заголовок

H2 Заголовок

H3 Заголовок

H4 Заголовок

`

Текст

`markdown Жирный текст Курсив Код ~~Зачеркнутый~~ `

Ссылки и изображения

`markdown Текст ссылки !Описание изображения `

Списки

`markdown
  • Элемент списка
  • Другой элемент
- Вложенный элемент
  1. Первый
  2. Второй
  3. Третий
`

Блоки кода

``markdown `php ` `` Поддерживаемые языки: php, javascript, python, bash, css, html и другие.

Цитаты

`markdown
Это цитата Может занимать несколько строк
`

Таблицы

`markdown | Заголовок 1 | Заголовок 2 | |-------------|-------------| | Ячейка 1 | Ячейка 2 | `

Горизонтальная линия

`markdown --- `

Организация документации

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

` docs/ ├── index.md # Главная страница ├── installation.md # Установка ├── guide.md # Руководство ├── api/ # Раздел API │ ├── index.md │ └── methods.md └── examples/ # Примеры 
└── basic.md
`

Вложенные страницы

Для создания вложенных разделов создайте папку и поместите в неё index.md: ` docs/ └── api/ 
├── index.md
├── authentication.md
└── endpoints.md
` Доступ: ?page=api, ?page=api/authentication

Настройка навигации

Отредактируйте config.php: `php 'navigation' => [ 
'Главная' => 'index',
'Документация' => 'docs',
'API' => 'api',
'Примеры' => 'examples',
'FAQ' => 'faq',
], `

Поиск

Встроенный поиск работает автоматически:
  1. Введите запрос в поле поиска
  2. Найденные фразы будут подсвечены на странице
  3. Поиск работает в реальном времени

Адаптивный дизайн

Документация автоматически адаптируется под мобильные устройства:
  • На мобильных устройствах навигация скрывается в меню
  • Кнопка меню появляется в верхнем левом углу
  • Все элементы оптимизированы для сенсорного управления

Подсветка синтаксиса

Подсветка кода работает автоматически через highlight.js: `javascript // Пример JavaScript function hello() { 
console.log("Hello, World!");
} ` `python

Пример Python

def hello(): 
print("Hello, World!")
`

Советы

  1. Используйте заголовки - они создают структуру документа
  2. Добавляйте примеры кода - они делают документацию понятнее
  3. Пишите простым языком - избегайте сложных терминов
  4. Обновляйте регулярно - актуальная документация важна
--- Далее: API документация