YFM Dev Server

Development server for Diplodoc documentation with live reload.

Описание на русском

Features

• Live Reload - Automatically rebuilds and refreshes on file changes
• Scroll Preservation - Maintains scroll position across reloads

Installation

# Run directly with npx (no installation needed)
npx yfmdevserver

# Or install globally
npm install -g yfmdevserver

Usage

# Basic usage (watches ./docs, serves on port 8080)
npx yfmdevserver

# Custom input/output directories and port
npx yfmdevserver -i ./docs -o ./build -p 3000

# With Diplodoc config file
npx yfmdevserver -i ./docs -c ./docs/.yfm

# Use custom build tool (if not using default 'yfm')
npx yfmdevserver -t ./node_modules/.bin/diplodoc

Options

Options:
  -V, --version        output the version number
  -i, --input <dir>    input directory to watch (default: "docs")
  -o, --output <dir>   output directory for built files (default: "out")
  -p, --port <number>  port for HTTP server (default: "8080")
  -d, --debounce <ms>  debounce time in milliseconds (default: "300")
  -c, --config <file>  path to yfm config file
  -t, --tool <file>    path to build tool executable (default: "yfm")
  -h, --help           display help for command

Requirements

• Node.js 18+
• YFM/Diplodoc CLI - Must be installed and available in PATH

  npm install -g @diplodoc/cli

Описание на русском

Dev сервер разработки для документации Diplodoc с live reload.

Фичи

• Live reload - Автоматическая пересборка и обновление при изменении файлов
• Сохранение позиции скролла - Сохраняет положение прокрутки при перезагрузке

Установка

# Запуск без установки
npx yfmdevserver

# Или установка глобально
npm install -g yfmdevserver

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

# Базовое использование (отслеживает ./docs, порт 8080)
npx yfmdevserver

# Свои директории и порт
npx yfmdevserver -i ./docs -o ./build -p 3000

# С конфигурационным файлом Diplodoc
npx yfmdevserver -i ./docs -c ./docs/.yfm

# Использование другого инструмента сборки
npx yfmdevserver -t ./node_modules/.bin/diplodoc

Опции

Опции:
  -V, --version        вывести номер версии
  -i, --input <dir>    директория для отслеживания (по умолчанию: "docs")
  -o, --output <dir>   директория для собранных файлов (по умолчанию: "out")
  -p, --port <number>  порт HTTP-сервера (по умолчанию: "8080")
  -d, --debounce <ms>  задержка перед пересборкой в мс (по умолчанию: "300")
  -c, --config <file>  путь к конфигурационному файлу yfm
  -t, --tool <file>    путь к исполняемому файлу сборки (по умолчанию: "yfm")
  -h, --help           показать справку

Требования

• Node.js 18+
• YFM/Diplodoc CLI - Должен быть установлен и доступен в PATH

  npm install -g @diplodoc/cli