Часто задаваемые вопросы (FAQ)

Общие вопросы#

Q: Что такое Docsbook?

A: Docsbook превращает вашу документацию GitHub в красивый сайт за 5 секунд. Просто подключите свой репозиторий GitHub, и все готово!

Q: Нужно ли мне платить, чтобы начать?

A: Нет! Бесплатный план включает 1 репозиторий, синхронизацию с GitHub и красивый дизайн. Premium ($29 однократно) добавляет пользовательский домен, переводы и многое другое.

Q: Какой тип репозитория мне нужен?

A: Любой публичный репозиторий GitHub с файлами markdown. Это может включать:

README.md
Документация проекта
Инструкции
API reference
Любые файлы markdown

Q: Поддерживаются ли приватные репозитории GitHub?

A: В настоящее время только публичные. Приватные репозитории запланированы на будущее.

Q: Нужно ли мне что-то настраивать в GitHub?

A: Нет! Просто подключите свою учетную запись через OAuth. Docsbook получит доступ к вашим публичным репозиториям.

Usage#

Q: Как мне обновить мою документацию?

A: Просто обновите файлы в GitHub — сайт автоматически синхронизируется.

Отредактируйте файл .md
Зафиксируйте изменения в GitHub
Откройте сайт Docsbook
Увидьте обновления!

Q: Как быстро обновляется документация?

A: Очень быстро, при следующем посещении:

Вы посещаете сайт
Docsbook проверяет GitHub на наличие нового контента
Показывает последнюю версию

Обычно: мгновенно.

Q: Почему мой сайт не обновился?

A: Проверьте:

Действительно ли коммит находится в GitHub? (Проверьте на github.com)
Вы обновили браузер? (Ctrl+F5)
Прошло ли 1-2 минуты?
Является ли расширение файла .md?

Q: Какую структуру папок мне следует использовать?

A: Любую! Мы рекомендуем:

repo/
├── README.md
├── docs/
│   ├── getting-started.md
│   ├── api/
│   └── guides/

Но любая другая структура тоже работает.

Q: Могу ли я использовать .markdown вместо .md?

A: Да, оба расширения работают.

Q: Работают ли ссылки между файлами?

A: Да! Используйте:

[Link](/ru/docs/path/to/file)
[Link to folder](/ru/docs/../folder/file)

Они автоматически преобразуются в правильные URL-адреса.

Q: Что насчет изображений?

A: Поместите их в папку (например, docs/images/) и ссылайтесь на них:

![Description](https://raw.githubusercontent.com/docsbook-io/docs/main/./images/screenshot.png)

Поддерживаются PNG, JPG, GIF, WebP.

Q: Могу ли я использовать HTML?

A: Markdown поддерживает HTML, поэтому да:

<div>Regular HTML</div>

Но мы рекомендуем обычный markdown.

Доступ и безопасность#

В: Кто может видеть мою документацию?

О: Все в интернете! Ваш сайт полностью публичный.

Люди без учетной записи GitHub
Боты поисковых систем (Google, Bing)
Любой

Это ожидаемо — вы хотите, чтобы все видели вашу документацию.

В: Как это связано с частным репозиторием GitHub?

О: Даже если репозиторий GitHub является частным, документация на Docsbook открыта. Это магия! 😊

(Частные репозитории пока не поддерживаются)

В: Безопасна ли моя документация?

О: Да, используются HTTPS (SSL) и Vercel CDN.

В: Может ли кто-то редактировать мою документацию через Docsbook?

О: Нет, это невозможно. Редактирование можно выполнять только в GitHub.

В: Кто видит плавающее виджет (кнопки управления)?

О: Только вы, когда вы вошли в систему. Другие люди видят только документацию.

Premium#

Q: Что такое Premium?

A: Разовая подписка ($29) с дополнительными функциями:

Неограниченное количество репозиториев
Пользовательский домен
Скрыть "Powered by Docsbook"
Автоматический перевод

Q: Сколько стоит Premium?

A: $29 USD единоразово, на всю жизнь. Первые 100 клиентов заплатили $19.

Q: Как я могу оплатить?

A: Нажмите "Upgrade to Premium" во Float Widget → введите данные своей карты в форме Stripe.

Принимаются: Visa, Mastercard, AmEx, Apple Pay, Google Pay.

Q: Безопасна ли оплата?

A: Да, на 100%. Платежи обрабатываются Stripe (мировым лидером). Docsbook никогда не видит номер вашей карты.

Q: Предусмотрен ли возврат средств?

A: Да, полный возврат средств в течение первых 30 дней. Свяжитесь с support@docsbook.io.

Q: Повысится ли цена?

A: Нет, $29 — постоянная цена. Вы платите один раз.

Q: Могу ли я купить Premium для нескольких рабочих пространств?

A: Да, но вам нужно купить его для каждого отдельно. Это доступно по цене ($29 за рабочее пространство).

Q: Есть ли скидки для организаций?

A: Свяжитесь с support@docsbook.io для специальных договоренностей.

Домены#

Q: Как использовать свой домен?

A: Премиум-функция. Руководство: Настройка собственного домена

TL;DR:

Введите домен в Настройки
Обновите DNS (добавьте CNAME)
Подождите 30 минут
Готово!

Q: Что лучше: корневой домен или поддомен?

A: Мы рекомендуем поддомен:

✅ docs.example.com (recommended)
✅ example.com (also works)
✅ guide.example.com (multiple can be used)

Q: Нужен ли мне SSL (HTTPS)?

A: Docsbook настраивает это автоматически через Let's Encrypt. Бесплатно и не требует никаких действий с вашей стороны.

Q: Сколько времени занимает распространение DNS?

A: Обычно 15-30 минут, максимум 48 часов.

Переводы#

Q: Как я могу перевести документацию?

A: Премиум-функция. Руководство: Переводы

TL;DR:

Откройте Настройки
Выберите языки
Нажмите Сохранить
Docsbook переводит за минуты

Q: Какие языки поддерживаются?

A: Более 100, включая:

Испанский, французский, немецкий
Русский, китайский, японский
Арабский, корейский, тайский
И многие другие

Q: Насколько хорош машинный перевод?

A: Хорошо для технической документации. Может потребоваться редактирование для идиом и культурных отсылок.

Q: Будут ли переводы обновляться при обновлении документации?

A: Да, автоматически.

Q: Могу ли я редактировать переводы?

A: Да, вы можете скачать и редактировать вручную. Свяжитесь с support@docsbook.io.

Поддержка & Проблемы#

Q: Как связаться с поддержкой?

A: Email: support@docsbook.io

Премиум-клиенты получают приоритет.

Q: Есть ли документация Docsbook?

A: Да, вы ее читаете! Смотрите другие разделы.

Q: Что делать, если что-то сломано?

A: Напишите на support@docsbook.io с описанием проблемы.

Q: Есть ли страница статуса?

A: Скоро. Следите за обновлениями на twitter.com/docsbook.

Технические вопросы#

Q: На чём построен Docsbook?

A: Next.js, React, Vercel, Stripe, GitHub API.

Q: Где хранятся данные?

A: На Vercel (серверы в США и других странах) и Neon Postgres.

Q: Какой парсер Markdown используется?

A: Remark + Rehype. Поддерживается GitHub Flavored Markdown (GFM).

Q: Работает ли поиск по сайту?

A: Встроенный поиск появится в ближайшее время. Пока используйте поиск в браузере (Ctrl+F).

Q: Есть ли тёмная тема?

A: Появится в ближайшее время. В настоящее время доступна только светлая тема.

Q: Сколько одновременных посетителей оно может обработать?

A: Vercel масштабируется автоматически. Не беспокойтесь о нагрузке.

Legal#

Q: Есть ли Условия использования?

A: Да, смотрите Условия (скоро).

Q: А как насчет Политики конфиденциальности?

A: Да, смотрите Политика конфиденциальности (скоро).

Q: Что, если я нарушу правила?

A: Мы свяжемся с вами. Обычно мы даем шанс исправить ситуацию.

Не нашли ответ на свой вопрос?#

Напишите на support@docsbook.io — мы будем рады помочь! 😊

Следующий: