https://valoryx.org/ru/docs/guides/ Recent content in Руководства on Valoryx Hugo ru https://valoryx.org/ru/docs/guides/editor/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/guides/editor/ Веб-редактор DocPlatform включает редактор форматированного текста на базе Tiptap (основан на ProseMirror), который отображает Markdown в реальном времени, сохраняя полную совместимость с исходным Markdown. Каждое ваше изменение формирует чистый файл .md — без проприетарных форматов и привязки к платформе. Макет редактора ┌─────────────────────────────────────────────────────────────┐ │ Sidebar │ Editor │ │ │ │ │ 📁 Getting │ ┌──────────────────────────────────┐ │ │ Started │ │ Frontmatter (collapsible) │ │ │ 📁 Guides │ │ Title: ___________________ │ │ │ 📁 API │ │ Description: ______________ │ │ │ > auth. https://valoryx.org/ru/docs/guides/markdown/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/guides/markdown/ Markdown и компоненты DocPlatform использует Markdown, совместимый со стандартом CommonMark, с YAML frontmatter и 7 пользовательскими компонентами для создания функциональной интерактивной документации. Основы Markdown DocPlatform поддерживает полную спецификацию CommonMark и распространенные расширения. Заголовки # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 Заголовки автоматически генерируют якорные идентификаторы для глубоких ссылок: ## My Section -> #my-section. Форматирование текста **Bold text** *Italic text* ~~Strikethrough~~ `Inline code` [Link text](https://example.com)  │ └──────┬───────┘ │ save ▼ ┌─────────────┐ ┌──────────────┐ │ Content │ commit │ Local Git │ push ┌──────────────┐ │ Ledger │ ───────► │ Repository │ ───────► │ Remote Repo │ │ │ │ (. https://valoryx.org/ru/docs/guides/collaboration/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/guides/collaboration/ Команды и совместная работа DocPlatform создан для командной работы над документацией. Приглашайте участников, назначайте гранулярные роли и отслеживайте каждое изменение с помощью полного журнала аудита. Участники workspace Каждый пользователь принадлежит одному или нескольким workspaces с определенной ролью. Роли определяют, какие действия может выполнять пользователь. Приглашение участников Через веб-интерфейс: Откройте Workspace Settings -> Members Нажмите Invite Member Введите email-адрес приглашаемого Выберите роль Нажмите Send Если настроен SMTP, отправляется email с приглашением и уникальной ссылкой. https://valoryx.org/ru/docs/guides/publishing/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/guides/publishing/ Публикация документации DocPlatform может предоставлять документацию как публичный веб-сайт с боковой навигацией, подсветкой синтаксиса и SEO-метаданными. Отдельный генератор статических сайтов не требуется. Как работает публикация Опубликованная документация доступна по адресу /p/{workspace-slug}/{page-path}: http://localhost:3000/p/my-docs/ → docs/index.md http://localhost:3000/p/my-docs/quickstart → docs/quickstart.md http://localhost:3000/p/my-docs/api/auth → docs/api/auth.md Страницы рендерятся из Markdown в HTML по запросу с использованием goldmark (совместим с CommonMark) и подсветкой синтаксиса Chroma для блоков кода. Жизненный цикл статуса страницы Страницы имеют поле status, управляющее их видимостью: https://valoryx.org/ru/docs/guides/search/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/guides/search/ Поиск DocPlatform включает встроенный полнотекстовый поисковый движок (Bleve), который автоматически индексирует весь контент. Не нужно настраивать внешний сервис — поиск работает сразу после установки. Использование поиска Диалог Cmd+K Нажмите Cmd+K (macOS) или Ctrl+K (Windows/Linux) в любом месте веб-редактора, чтобы открыть диалог поиска. ┌──────────────────────────────────────────┐ │ 🔍 Search documentation... │ ├──────────────────────────────────────────┤ │ │ │ 📄 Getting Started │ │ Install and configure DocPlatform... │ │ │ │ 📄 API Authentication │ │ JWT tokens, OAuth2, and session. https://valoryx.org/ru/docs/guides/analytics/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/guides/analytics/ Analytics DocPlatform includes built-in analytics for tracking how your documentation is used. No third-party tracking scripts or external services required. How it works Analytics data is collected in a separate analytics.db SQLite database (not in the main database). This separation ensures analytics never impact content performance. What is tracked Data point Description Page path Which page was viewed Referrer Where the visitor came from Timestamp When the page was viewed Search queries What users searched for What is NOT tracked IP addresses (never stored) User agents are not stored Cookies or cross-session identifiers (without consent) Personally identifiable information GDPR compliance Analytics requires explicit cookie consent from visitors. https://valoryx.org/ru/docs/guides/billing/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/guides/billing/ Billing & Plans DocPlatform uses Stripe for subscription billing. Three plan tiers are available, each with different limits and features. Plans Feature Community (Free) Free Team ($29/mo) Business ($79/mo) Editors Unlimited 3 15 50 Workspaces Unlimited 1 3 10 Viewers / Commenters Unlimited Unlimited Unlimited Unlimited Pages Unlimited 50 150 500 Published docs Unlimited Unlimited Unlimited Unlimited Analytics — — Included Included Custom domains — — Included Included Advanced AI — — Included Included Priority support — — — Included Annual pricing Annual subscriptions include 2 months free: https://valoryx.org/ru/docs/guides/mcp/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/guides/mcp/ MCP Server — AI Integration Guide DocPlatform includes a built-in Model Context Protocol (MCP) server that lets AI assistants read, write, search, and manage your documentation directly. Instead of copy-pasting content into chat windows, your AI tools work with your docs natively. Prerequisites DocPlatform running (binary, Docker, or Fly.io) An API key (create one in Workspace Settings → API Keys) Quick start 1. Create an API key In your DocPlatform instance, go to Workspace Settings → API Keys → Create Key.