https://valoryx.org/uk/docs/guides/ Recent content in Посібники on Valoryx Hugo uk https://valoryx.org/uk/docs/guides/editor/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/docs/guides/editor/ Веб-редактор DocPlatform містить редактор форматованого тексту, побудований на Tiptap (на базі ProseMirror), який відображає Markdown у реальному часі, зберігаючи повну сумісність із сирцевим Markdown. Кожна ваша зміна створює чистий .md файл — без пропрієтарних форматів, без прив’язки до платформи. Розташування елементів редактора ┌─────────────────────────────────────────────────────────────┐ │ Sidebar │ Editor │ │ │ │ │ 📁 Getting │ ┌──────────────────────────────────┐ │ │ Started │ │ Frontmatter (collapsible) │ │ │ 📁 Guides │ │ Title: ___________________ │ │ │ 📁 API │ │ Description: ______________ │ │ │ > auth. https://valoryx.org/uk/docs/guides/markdown/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/docs/guides/markdown/ Markdown та компоненти DocPlatform використовує Markdown, сумісний із CommonMark, з YAML frontmatter та 7 користувацькими компонентами для багатої інтерактивної документації. Основи Markdown DocPlatform підтримує повну специфікацію CommonMark плюс поширені розширення. Заголовки # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 Заголовки автоматично генерують anchor ID для глибоких посилань: ## My Section → #my-section. Форматування тексту **Bold text** *Italic text* ~~Strikethrough~~ `Inline code` [Link text](https://example.com)  Списки - Unordered item - Another item - Nested item 1. https://valoryx.org/uk/docs/guides/git-integration/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/docs/guides/git-integration/ Інтеграція з Git Двонаправлена синхронізація git у DocPlatform дозволяє вашій команді працювати так, як їм зручно. Технічні письменники використовують веб-редактор. Розробники відправляють із IDE. Усі бачать однаковий контент. Як це працює ┌─────────────┐ │ Web Editor │ │ (browser) │ └──────┬───────┘ │ save ▼ ┌─────────────┐ ┌──────────────┐ │ Content │ commit │ Local Git │ push ┌──────────────┐ │ Ledger │ ───────► │ Repository │ ───────► │ Remote Repo │ │ │ │ (. https://valoryx.org/uk/docs/guides/collaboration/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/docs/guides/collaboration/ Команди та співпраця DocPlatform розроблений для командної документації. Запрошуйте учасників, призначайте детальні ролі та відстежуйте кожну зміну за допомогою повного журналу аудиту. Членство в робочому просторі Кожен користувач належить до одного або кількох робочих просторів із конкретною роллю. Ролі визначають, які дії може виконувати користувач. Запрошення учасників Через веб-інтерфейс: Відкрийте Workspace Settings → Members Натисніть Invite Member Введіть електронну адресу особи Оберіть роль Натисніть Send Якщо SMTP налаштовано, надсилається електронний лист із запрошенням з унікальним посиланням. https://valoryx.org/uk/docs/guides/publishing/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/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/uk/docs/guides/search/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/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/uk/docs/guides/analytics/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/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/uk/docs/guides/billing/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/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/uk/docs/guides/mcp/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/uk/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.