Установка
Руководство по установке и настройке движка документации.
Требования
Для работы движка необходимо:
- PHP 7.4 или выше
- Веб-сервер (Apache/Nginx)
- Mod_rewrite (для Apache)
Шаг 1: Загрузка файлов
Разместите все файлы движка на вашем веб-сервере:
`bash
docs.dev-pack.ru/
├── index.php
├── config.php
├── .htaccess
├── src/
│ ├── DocsEngine.php
│ └── MarkdownParser.php
├── templates/
│ └── layout.php
├── assets/
│ ├── css/
│ └── js/
└── docs/
└── ваши-файлы.md
`
Шаг 2: Настройка веб-сервера
Apache
Убедитесь, что модуль mod_rewrite включен:
`bash
a2enmod rewrite
systemctl restart apache2
`
Файл .htaccess уже настроен и находится в корне проекта.
Nginx
Добавьте в конфигурацию:
`nginx
server {
listen 80;
server_name docs.dev-pack.ru;
root /path/to/docs.dev-pack.ru;
index index.php;
location / {
try_files $uri $uri/ /index.php?page=$uri;
}
location ~ \.php$ {
fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgiparam SCRIPTFILENAME $documentroot$fastcgiscript_name;
}
}
`
Шаг 3: Настройка конфигурации
Откройте файл config.php и настройте параметры:
`php
return [
'site_name' => 'Название вашего сайта',
'site_description' => 'Описание',
'theme' => 'default',
'language' => 'ru',
'navigation' => [
'Главная' => 'index',
'Установка' => 'installation',
// Добавьте свои разделы
],
];
`
Шаг 4: Создание документации
Создайте файлы Markdown в папке docs/:
`markdown
---
title: Заголовок страницы
description: Описание страницы
---
Заголовок
Ваш контент здесь...
`
Проверка установки
Откройте сайт в браузере. Если все настроено правильно, вы увидите главную страницу документации.
Устранение проблем
Ошибка 404
- Проверьте, что mod_rewrite включен
- Убедитесь, что
.htaccess находится в корне
- Проверьте права доступа к файлам
Не отображается CSS/JS
- Проверьте пути к файлам в
layout.php
- Убедитесь, что папка
assets/ доступна
Не парсится Markdown
- Проверьте наличие файлов в папке
docs/
- Убедитесь, что файлы имеют расширение
.md
---
Следующий раздел: Руководство пользователя