new

readme.md

@@ -1,26 +1,21 @@
-Для разработки и проверки документации можно использовать команды
-* mkdocs serve (с созданием pdf файлов)
-* mkdocs serve -f dev.yml (без создания pdf файлов)
-* mkdocs build -f admin-manuals.yml (с созданием  pdf файла с инструкциями для администратора)
 
-Перед запуском надо установить mkdocs и его расширения. Сделать это можно при помощи команды, запущенной в папке mkdocs
-```
-pip install -r requirements.txt
-```
+# Разработка документации (Zensical)
 
-Чтобы включить увеличение изображения, необходимо добавить . Если не работает (а это происходит при работе плагина img2fig), то использовать html-вариант. Автоматический конвертер первого варианта во второй (zoom.py) есть в bitedo-doc и документации ERP.
-```
-а) ![Рис 1](examplel.png)
-б) <img alt="Рис 1" src="examplel.png" class="zoom"/>
-```
+## Локальная разработка с live-превью
 
-В случае ошибки **no library called "cairo" was found** необходимо скачать библиотеки:
+**Zensical** имеет встроенный dev-сервер с **live-reload** — это полноценная и более быстрая замена старой команде `mkdocs serve`.
 
-https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer
+### Как запустить
 
-https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer/releases
+1. Установите Zensical:
 
-Если при запуске команды **mkdocs serve -f dev.yml** появляется ошибка что данная команда не определена, то в переменнах средах укажите путь: **C:\Users\User\AppData\Roaming\Python\Python310\Scripts**
+```bash
+pip install zensical
 
+Перейдите в корень проекта и запустите dev-сервер:
 
-333
+zensical serve
+
+Или явно указав конфигурационный файл:
+
+zensical serve --config-file zensical.toml