📘 DB-Labs — шаблон документації на VitePress

Це зручний шаблон на базі VitePress та pnpm, створений для оформлення лабораторних робіт із дисципліни «Організація баз даних».
Він дозволяє швидко запускати локальний сервер документації, автоматично збирати статичний сайт та публікувати його на GitHub Pages.

Шаблон підтримує:

• структуровану навігацію (sidebar / navbar),
• діаграми (PlantUML),
• блоки‑підказки (admonition),
• чекбокси,
• автоматичний пошук.

🚀 Як розпочати роботу

Це JavaScript‑шаблон, який базується на VitePress і керується через pnpm.
Перед початком переконайтесь, що у вас встановлено:

• Node.js (версія 18 або вище) – https://nodejs.org/
• pnpm – встановити глобально:

  npm install -g pnpm

🔁 Кроки встановлення

1. Fork цього репозиторію у свій GitHub-акаунт.
   ‼️УВАГА
   Якщо під час форку плануєте перейменувати репозиторій (наприклад, із DB-Labs на ABC), запам’ятайте нову назву — вона знадобиться у файлі docs/.vitepress/config.mts у параметрі base.

2. Клонуйте форк на комп’ютер:

   git clone https://github.com/<ваш-логін>/<ваша-назва>.git
   cd <ваша-назва>

3. Перевірте параметр base
   Відкрийте docs/.vitepress/config.mts і переконайтесь, що рядок

   base: '/<ваша-назва>/',

   точно відповідає назві форкнутого репозиторію.

4. Встановіть залежності:

   pnpm install

5. Запустіть локальний сервер:

   pnpm dev

   Після запуску сайт буде доступний за адресою
   http://localhost:5173/<ваша-назва>/
   Усі зміни підхоплюються автоматично – редагуйте файли у docs/ і одразу бачите результат.

📚 Методичні матеріали

У папці docs/guidelines знаходяться два основні документи:

• guidelines.md — методичка з вимогами та структурою звітів.
• themes.md — список доступних тем, із яких можна обрати власну.

Рекомендується спочатку ознайомитись із цими файлами, а вже потім переходити до оформлення звіту.

📂 Структура проєкту

DB-Labs/
├─ .github/
│  └─ workflows/deploy.yml        # CI‑деплой
├─ docs/
│  ├─ .vitepress/
│  │  ├─ config.mts               # Налаштування
│  │  └─ theme/index.ts           # Стилі
│  ├─ Lab1/README.md              # Лабораторна 1
│  ├─ Lab2/README.md              # Лабораторна 2
│  ├─ Lab3/README.md              # Лабораторна 3
│  ├─ Lab4/README.md              # Лабораторна 4
│  ├─ Lab5/README.md              # Лабораторна 5
│  ├─ Lab6/README.md              # Лабораторна 6
│  ├─ other/
│  │  ├─ authors/README.md        # Автори
│  │  ├─ conclusion/README.md     # Висновки
│  │  ├─ intro/README.md          # Вступ
│  │  └─ requirements/README.md   # Вимоги (не змінювати)
│  └─ index.md                    # Головна сторінка
├─ guidelines/
│  ├─ guidelines.md               # Методичка
│  └─ themes.md                   # Теми проєктів
├─ package.json                   # Скрипти та залежності
├─ pnpm-lock.yaml                 # Локфайл залежностей
├─ README.md                      # (цей файл)
└─ LICENSE                        # MIT

🔨 Основні команди

Команда	Опис
pnpm install	Встановлення усіх залежностей
pnpm dev	Локальний сервер (hot‑reload)
pnpm build	Збірка сайту → docs/.vitepress/dist
pnpm preview	Перегляд зібраного сайту (продакшн‑режим)

🌐 Автоматичний деплой

Проєкт налаштований на деплой через GitHub Actions: після кожного пушу в main статичні файли автоматично публікуються на GitHub Pages.

🔧 Умови успішного деплою

1. Репозиторій публічний.
2. У Settings → Pages обрано Source → GitHub Actions.
3. Після пушу сайт з’явиться за адресою
   https://<ваш-логін>.github.io/<ваша-назва>/

💡ПРИМІТКА
Щоб кнопка GitHub у хедері вела саме на ваш форк, змініть посилання у socialLinks:

socialLinks: [
  { icon: 'github', link: 'https://github.com/<ваш-логін>/<ваша-назва>' },
],

🧩 Можливості шаблону

• Автоматичний sidebar / navbar
• PlantUML для UML‑діаграм прямо у Markdown
• Admonition‑блоки – оформлені підказки (!!! note)
• Checkbox‑списки для статус‑трекінгу
• Локальний пошук по документації
• 1‑клік деплой на GitHub Pages

Додаткові плагіни підключені через config.mts; стилі – через Theme API.

---

👨‍💻 Автор

Цей шаблон створено Pliffdax з метою спростити оформлення лабораторних робіт для студентів, які вивчають дисципліну «Організація баз даних».

Ви можете вільно форкати, змінювати та використовувати шаблон у власних цілях.
Ліцензія: MIT

---

З будь-якими запитаннями або пропозиціями звертайтесь у Telegram або Issues репозиторію.