@go-core/docs-engine

@go-core/docs-engine — это движок для документации проектов на Node.js/TypeScript с поддержкой Express, рендерингом Markdown, шаблонами и встроенным сервером предпросмотра.
Библиотека позволяет быстро развернуть сервер документации для ваших проектов, а также предоставляет CLI-утилиту для локального запуска.

Возможности

• 📖 Генерация документации из Markdown-файлов
• 💡 Встроенный сервер на Express для предпросмотра документации
• 🎛️ Поддержка шаблонов (EJS, Pug)
• 🏷️ Примеры использования в каталоге examples/
• 🗂️ Гибкая структура и настройка путей к документации и статическим ресурсам
• 🛠️ CLI для быстрого запуска: ccs-docs-serve

Установка

npm install @go-core/docs-engine

Быстрый старт

Создайте файл index.ts (или используйте пример из examples/):

import path from "path";
import { startDocsServer } from "@go-core/docs-engine";

// Абсолютный путь к папке с вашей документацией
const docsPath = path.join(process.cwd(), "docs");

// Запуск сервера документации
startDocsServer(3009, { documentsRoot: docsPath });

Запуск сервера:

ts-node src/index.ts
# или после сборки
node dist/src/index.js

Документация будет доступна по адресу http://127.0.0.1:3009

Использование CLI

В пакете доступна команда для быстрого запуска сервера документации:

npx ccs-docs-serve

Структура проекта

• src/ — исходный код библиотеки
• examples/ — примеры интеграции и запуска
• public/ — публичные статические файлы (CSS, JS, изображения)
• docs/ — ваша документация в формате Markdown (пример, путь настраивается)
• bin/ — CLI-утилиты

Публикация и исходники

В npm публикуются только исходники, папка examples/ и необходимые ресурсы.
Документация для пользователей находится на GitHub

Автор и лицензия

Автор: LLC Complex Cloud Solution, Ivan Goptarev [email protected]
Сайт: https://ccs.msk.ru
Лицензия: MIT

Репозиторий

Исходный код: https://github.com/CCSMSKRU/CCS.Docs.git

Вопросы и поддержка

Для багрепортов и предложений используйте Issues на GitHub или пишите автору по email.