lapki-docserver

Этот репозиторий содержит:

• «референсную» версию документации Lapki IDE (docs/ и index.json)
• скрипт генерации индекс-файла (make_index.py)
• примеры конфигурации для сервера (configs/)

Развёртывание сервера

Общий порядок развёртывания имеет следующий вид:

• взять узел (физический или VDS), установить на него HTTP-сервер (например, Ngnix или Apache);
• настроить выдачу файла index.json и директории docs;
• настроить CORS;
• при желании настроить SSL.

Подробности этих операций можно узнать в документации к конкретному HTTP-серверу. В папке configs/ лежат типовые примеры конфигурации для Nginx.

Дополнение документации

При размещении у себя вы можете свободно менять содержимое и структуру документации. Кроме HTML-страниц клиент поддерживает показ произвольных файлов в виде прямой ссылки на скачивание в браузере.

После операций с документацией выполните make_index.py (потребуется Python 3), чтобы перегенерировать индекс-файл. При необходимости поправьте ключи name вручную, чтобы поменять названия документов.

При необходимости вы можете использовать скрипты и таблицы стилей, но желательно подключать их внешними ссылками, либо размещать их за пределами директории docs (для меньшей работы с индекс-файлом).