Швидкий старт

Від нуля до працюючої документаційної платформи менш ніж за 5 хвилин. Цей посібник охоплює найшвидший шлях — для детальних варіантів див. посібник Встановлення.

Крок 1: Встановлення

# Recommended (auto-detects platform)
curl -fsSL https://valoryx.org/install.sh | sh

Або завантажте вручну:

curl -sLO https://github.com/Valoryx-org/releases/releases/latest/download/docplatform-linux-amd64
chmod +x docplatform-linux-amd64
sudo mv docplatform-linux-amd64 /usr/local/bin/docplatform

Або з Docker:

docker run -d --name docplatform -p 3000:3000 -v docplatform-data:/data ghcr.io/valoryx-org/docplatform:latest

Якщо використовуєте Docker, перейдіть до Кроку 3 — контейнер ініціалізується автоматично.

Крок 2: Ініціалізація робочого простору

docplatform init --workspace-name "My Docs" --slug my-docs

Це створює:

.docplatform/
├── data.db              # SQLite database
├── jwt-key.pem          # Auto-generated RS256 signing key
└── workspaces/
    └── {workspace-id}/
        ├── docs/        # Your documentation lives here
        └── .docplatform/
            └── config.yaml

З git (опціонально)

Підключіться до наявного git репозиторію під час ініціалізації:

docplatform init \
  --workspace-name "My Docs" \
  --slug my-docs \
  --git-url [email protected]:your-org/docs.git \
  --branch main

DocPlatform клонує репозиторій та починає синхронізацію. Усі наявні .md файли автоматично індексуються.

Крок 3: Запуск сервера

docplatform serve

INFO  Server starting            port=3000 version=v0.5.2
INFO  Database initialized       path=.docplatform/data.db
INFO  Search index ready         documents=0
INFO  Workspace loaded           name="My Docs" slug=my-docs
INFO  Listening on               http://localhost:3000

Відкрийте http://localhost:3000 у браузері.

Крок 4: Зареєструйте обліковий запис

Перший зареєстрований користувач автоматично стає Super Admin із повним доступом до платформи.

1. Натисніть Create Account
2. Введіть ім’я, електронну пошту та пароль
3. Ви увійшли в систему та готові писати

Примітка безпеки: Механізм «перший користувач стає адміністратором» діє лише коли жодного користувача не існує. Після першої реєстрації нові облікові записи отримують роль за замовчуванням, налаштовану для робочого простору.

Крок 5: Створіть першу сторінку

1. Натисніть New Page на бічній панелі
2. Дайте їй назву — URL slug генерується автоматично з назви
3. Почніть писати в багатофункціональному редакторі
4. Зміни автоматично зберігаються кожні кілька секунд

Сторінка зберігається як Markdown файл у директорії docs/ вашого робочого простору. Якщо ви підключили git, вона автоматично фіксується та відправляється.

Крок 6: Спробуйте

Ось кілька речей, які варто спробувати одразу:

Що далі