FAQ - Часто задаваемые вопросы

Общие вопросы

Что такое этот движок?

Это простой и быстрый движок документации на PHP, который конвертирует файлы Markdown в красивые HTML страницы.

Какие требования для работы?

  • PHP 7.4+
  • Веб-сервер (Apache/Nginx)
  • Модуль mod_rewrite (для Apache)

Нужна ли база данных?

Нет, движок работает полностью без базы данных. Все страницы хранятся в виде файлов Markdown.

Установка и настройка

Как установить движок?

См. раздел Установка.

Как изменить название сайта?

Отредактируйте config.php: `php 'site_name' => 'Новое название', `

Как добавить новую страницу в навигацию?

Отредактируйте массив navigation в config.php: `php 'navigation' => [ 
'Новая страница' => 'new-page',
], ` Затем создайте файл docs/new-page.md.

Как изменить дизайн?

Отредактируйте файл assets/css/style.css или создайте свою тему.

Работа с документацией

Какой синтаксис Markdown поддерживается?

Поддерживаются все основные элементы:
  • Заголовки
  • Списки
  • Ссылки
  • Изображения
  • Блоки кода
  • Таблицы
  • Цитаты
См. подробнее в Руководстве.

Можно ли использовать HTML в Markdown?

Да, можно вставлять HTML код прямо в Markdown файлы.

Как добавить изображение?

`markdown !Описание ` Поместите изображения в папку assets/images/ или используйте внешние URL.

Как создать вложенные страницы?

Создайте подпапку в docs/: ` docs/ └── category/ 
├── index.md
└── page.md
` Доступ: ?page=category или ?page=category/page

Функционал

Есть ли поиск по документации?

Да, встроенный поиск находится в верхней части страницы. Он ищет текст на текущей странице.

Поддерживается ли подсветка синтаксиса?

Да, используется highlight.js для подсветки более 190 языков программирования.

Работает ли на мобильных устройствах?

Да, дизайн полностью адаптивный и отлично работает на всех устройствах.

Можно ли кэшировать страницы?

Папка cache/ создается автоматически, но кэширование нужно реализовать самостоятельно в классе DocsEngine.

Проблемы и решения

Страница не найдена (404)

Причины:
  • Файл .md не существует
  • Неправильный путь к файлу
  • Проблемы с mod_rewrite
Решение:
  1. Проверьте, что файл существует в docs/
  2. Проверьте .htaccess и mod_rewrite
  3. Проверьте права доступа к файлам

Не работает навигация

Решение:
  • Проверьте настройки в config.php
  • Убедитесь, что страницы существуют
  • Очистите кэш браузера

Не отображаются стили

Решение:
  • Проверьте пути в layout.php
  • Убедитесь, что папка assets/ доступна
  • Проверьте консоль браузера на ошибки

Markdown не парсится

Решение:
  • Проверьте синтаксис Markdown
  • Убедитесь, что файл имеет расширение .md
  • Проверьте кодировку файла (должна быть UTF-8)

Ошибка 500

Решение:
  • Проверьте логи PHP
  • Убедитесь, что версия PHP 7.4+
  • Проверьте права доступа к файлам и папкам

Расширение

Можно ли добавить свои функции?

Да, вы можете расширить классы DocsEngine и MarkdownParser.

Как добавить свои плагины?

Создайте файл в папке plugins/ и подключите его в index.php.

Поддерживается ли мультиязычность?

В базовой версии нет, но можно реализовать, создав структуру: ` docs/ ├── ru/ └── en/ `

Производительность

Насколько быстро работает движок?

Движок очень быстрый, т.к. не использует базу данных. Среднее время рендеринга страницы < 10ms.

Сколько страниц можно создать?

Ограничений нет. Движок справится с сотнями и тысячами страниц.

Нужно ли кэширование?

Для небольших сайтов не обязательно. Для больших - рекомендуется реализовать кэширование HTML.

Безопасность

Безопасен ли движок?

Да, все входные данные очищаются от опасных символов. Используется функция sanitizePath() для защиты от path traversal атак.

Нужна ли дополнительная защита?

Рекомендуется:
  • Использовать HTTPS
  • Настроить правильные права доступа (644 для файлов, 755 для папок)
  • Регулярно обновлять PHP
--- Не нашли ответ? Создайте issue на GitHub или напишите нам!