Docsbook
Обзор

Основные понятия

Что такое Workspace?#

Workspace — ваша документация, связанная с одним репозиторием GitHub.

Workspace включает в себя:

  • Ваш репозиторий с файлами markdown
  • Сайт документации (адрес и внешний вид)
  • Настройки (домен, перевод, стилизация)

Как это работает?#

1. You create a Workspace from your GitHub repo
                    ↓
2. Docsbook reads markdown files from GitHub
                    ↓
3. Transforms them into a beautiful site
                    ↓
4. Site is available at: docsbook.io/{user}/{repo}
                    ↓
5. You update files in GitHub
                    ↓
6. Site updates automatically

Структура сайта#

Левая панель — Навигация (Боковая панель)#

Боковая панель создается на основе структуры файлов вашего репозитория:

docs/
├── README.md          → "Home"
├── getting-started.md → "Getting Started"
├── api/
│   ├── auth.md        → "API / Auth"
│   └── endpoints.md   → "API / Endpoints"
└── faq.md             → "FAQ"

Отображается как:

📘 Home
📄 Getting Started
📁 API
  └─ Auth
  └─ Endpoints
📄 FAQ

Основное содержимое#

Центральная область отображает содержимое выбранного markdown-файла.

Особенности:

  • Красивое форматирование
  • Подсветка синтаксиса
  • Таблицы и списки
  • Ссылки на другие страницы

Правая панель — Оглавление#

Справа автоматически создается оглавление из заголовков текущей страницы.

Outline:
  - Installation
    - Requirements
    - Steps
  - Usage
  - Troubleshooting

Нажмите на заголовок → страница прокручивается к нему.

Float Widget — Control Widget#

Когда вы войшли в систему и просматриваете собственную документацию, в правом нижнем углу появляется виджет.

Кто видит виджет?#

  • ✅ Вы — видите свой виджет
  • ❌ Другие люди — не видят его (только в вашей учетной записи)

Что показывает?#

┌─────────────────────────┐
│ 👤 alice               │
│ ✨ Premium             │
│ ⚙️ Settings            │
│ 🚪 Sign out            │
└─────────────────────────┘

Что вы можете делать с виджетом?#

  1. Посмотреть аватар — клик для меню
  2. Посмотреть статус — Free или Premium
  3. Открыть настройки — для изменения домена, включения перевода
  4. Выйти — выйти из системы

Публичный доступ#

Ваша документация открыта для всех. Даже если репозиторий является приватным, документация видна всем.

Преимущества:

  • SEO оптимизация (индексируется Google)
  • Красивый внешний вид вместо простого GitHub
  • Быстрая загрузка
  • Адаптивность для мобильных устройств
  • Полнотекстовый поиск (скоро)

Синхронизация с GitHub#

Как работает синхронизация?#

Docsbook не использует вебхуки. Вместо этого:

  1. Вы обновляете файлы в GitHub
  2. Вы посещаете сайт документации
  3. Docsbook проверяет GitHub на наличие нового контента
  4. Если есть изменения — отображает новую версию

Результат: Документация всегда актуальна, как только вы на нее смотрите.

Что такое синхронизация?#

  • ✅ Новые .md файлы
  • ✅ Обновления текста
  • ✅ Удаления файлов
  • ✅ Переименования файлов
  • ✅ Новые папки

Что не синхронизируется?#

  • ❌ Комментарии в коде
  • ❌ История коммитов
  • ❌ Информация о ветках
  • ❌ Другие форматы (.txt, .rst, и т.д.)

Бесплатная vs Премиум#

Бесплатный план#

  • ✅ 1 публичный репозиторий
  • ✅ Синхронизация с GitHub
  • ✅ SEO-оптимизация
  • ✅ Красивый дизайн
  • ✅ Адаптивность для мобильных устройств
  • ❌ Пользовательский домен
  • ❌ Удаление "Powered by Docsbook"
  • ❌ Переводы на другие языки

Premium ($29 one-time lifetime)#

Get everything from Free, plus:

  • ✅ Неограниченное количество репозиториев
  • ✅ Пользовательский домен (docs.example.com)
  • ✅ Удалить водяной знак "Powered by Docsbook"
  • ✅ Перевод на любой язык
  • ✅ Приоритетная поддержка

Как начать работу?#

Готовы? Создайте свое первое рабочее пространство за 3 минуты.

Есть вопросы? Смотрите FAQ.

Работает на Docsbook