doccupine 0.0.89 → 0.0.90

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. package/dist/index.js +127 -1
  2. package/dist/templates/components/layout/Button.d.ts +1 -1
  3. package/dist/templates/components/layout/Button.js +9 -0
  4. package/dist/templates/components/layout/Footer.d.ts +1 -1
  5. package/dist/templates/components/layout/Footer.js +1 -1
  6. package/dist/templates/llms/llmsFull.d.ts +12 -0
  7. package/dist/templates/llms/llmsFull.js +59 -0
  8. package/dist/templates/llms/llmsIndex.d.ts +9 -0
  9. package/dist/templates/llms/llmsIndex.js +105 -0
  10. package/dist/templates/llms/llmsPage.d.ts +2 -0
  11. package/dist/templates/llms/llmsPage.js +20 -0
  12. package/dist/templates/mdx/accordion.mdx.d.ts +1 -1
  13. package/dist/templates/mdx/accordion.mdx.js +21 -16
  14. package/dist/templates/mdx/ai-assistant.mdx.d.ts +1 -1
  15. package/dist/templates/mdx/ai-assistant.mdx.js +22 -5
  16. package/dist/templates/mdx/analytics.mdx.d.ts +1 -1
  17. package/dist/templates/mdx/analytics.mdx.js +15 -4
  18. package/dist/templates/mdx/buttons.mdx.d.ts +1 -1
  19. package/dist/templates/mdx/buttons.mdx.js +10 -2
  20. package/dist/templates/mdx/callouts.mdx.d.ts +1 -1
  21. package/dist/templates/mdx/callouts.mdx.js +10 -17
  22. package/dist/templates/mdx/cards.mdx.d.ts +1 -1
  23. package/dist/templates/mdx/cards.mdx.js +10 -5
  24. package/dist/templates/mdx/code.mdx.d.ts +1 -1
  25. package/dist/templates/mdx/code.mdx.js +7 -3
  26. package/dist/templates/mdx/color-swatches.mdx.d.ts +1 -1
  27. package/dist/templates/mdx/color-swatches.mdx.js +7 -4
  28. package/dist/templates/mdx/columns.mdx.d.ts +1 -1
  29. package/dist/templates/mdx/columns.mdx.js +3 -0
  30. package/dist/templates/mdx/commands.mdx.d.ts +1 -1
  31. package/dist/templates/mdx/commands.mdx.js +7 -4
  32. package/dist/templates/mdx/components.mdx.d.ts +1 -1
  33. package/dist/templates/mdx/components.mdx.js +1 -0
  34. package/dist/templates/mdx/deployment-and-hosting.mdx.d.ts +1 -1
  35. package/dist/templates/mdx/deployment-and-hosting.mdx.js +6 -0
  36. package/dist/templates/mdx/fields.mdx.d.ts +1 -1
  37. package/dist/templates/mdx/fields.mdx.js +3 -0
  38. package/dist/templates/mdx/fonts.mdx.d.ts +1 -1
  39. package/dist/templates/mdx/fonts.mdx.js +13 -2
  40. package/dist/templates/mdx/footer-links.mdx.d.ts +1 -1
  41. package/dist/templates/mdx/footer-links.mdx.js +5 -0
  42. package/dist/templates/mdx/globals.mdx.d.ts +1 -1
  43. package/dist/templates/mdx/globals.mdx.js +16 -13
  44. package/dist/templates/mdx/headers-and-text.mdx.d.ts +1 -1
  45. package/dist/templates/mdx/headers-and-text.mdx.js +22 -2
  46. package/dist/templates/mdx/icons.mdx.d.ts +1 -1
  47. package/dist/templates/mdx/icons.mdx.js +3 -0
  48. package/dist/templates/mdx/image-and-embeds.mdx.d.ts +1 -1
  49. package/dist/templates/mdx/image-and-embeds.mdx.js +19 -10
  50. package/dist/templates/mdx/index.mdx.d.ts +1 -1
  51. package/dist/templates/mdx/index.mdx.js +2 -2
  52. package/dist/templates/mdx/lists-and-tables.mdx.d.ts +1 -1
  53. package/dist/templates/mdx/lists-and-tables.mdx.js +8 -2
  54. package/dist/templates/mdx/media-and-assets.mdx.d.ts +1 -1
  55. package/dist/templates/mdx/media-and-assets.mdx.js +14 -5
  56. package/dist/templates/mdx/model-context-protocol.mdx.d.ts +1 -1
  57. package/dist/templates/mdx/model-context-protocol.mdx.js +31 -15
  58. package/dist/templates/mdx/navigation.mdx.d.ts +1 -1
  59. package/dist/templates/mdx/navigation.mdx.js +9 -0
  60. package/dist/templates/mdx/platform/ai-assistant.mdx.d.ts +1 -1
  61. package/dist/templates/mdx/platform/ai-assistant.mdx.js +7 -0
  62. package/dist/templates/mdx/platform/analytics.mdx.d.ts +1 -1
  63. package/dist/templates/mdx/platform/analytics.mdx.js +7 -0
  64. package/dist/templates/mdx/platform/billing.mdx.d.ts +1 -1
  65. package/dist/templates/mdx/platform/billing.mdx.js +8 -0
  66. package/dist/templates/mdx/platform/build-and-deploy.mdx.d.ts +1 -1
  67. package/dist/templates/mdx/platform/build-and-deploy.mdx.js +6 -0
  68. package/dist/templates/mdx/platform/creating-a-project.mdx.d.ts +1 -1
  69. package/dist/templates/mdx/platform/creating-a-project.mdx.js +7 -0
  70. package/dist/templates/mdx/platform/custom-domains.mdx.d.ts +1 -1
  71. package/dist/templates/mdx/platform/custom-domains.mdx.js +5 -0
  72. package/dist/templates/mdx/platform/external-links.mdx.d.ts +1 -1
  73. package/dist/templates/mdx/platform/external-links.mdx.js +5 -0
  74. package/dist/templates/mdx/platform/file-editor.mdx.d.ts +1 -1
  75. package/dist/templates/mdx/platform/file-editor.mdx.js +7 -0
  76. package/dist/templates/mdx/platform/fonts-settings.mdx.d.ts +1 -1
  77. package/dist/templates/mdx/platform/fonts-settings.mdx.js +5 -0
  78. package/dist/templates/mdx/platform/index.mdx.d.ts +1 -1
  79. package/dist/templates/mdx/platform/index.mdx.js +5 -0
  80. package/dist/templates/mdx/platform/navigation-settings.mdx.d.ts +1 -1
  81. package/dist/templates/mdx/platform/navigation-settings.mdx.js +20 -4
  82. package/dist/templates/mdx/platform/project-settings.mdx.d.ts +1 -1
  83. package/dist/templates/mdx/platform/project-settings.mdx.js +4 -0
  84. package/dist/templates/mdx/platform/publishing.mdx.d.ts +1 -1
  85. package/dist/templates/mdx/platform/publishing.mdx.js +6 -0
  86. package/dist/templates/mdx/platform/site-settings.mdx.d.ts +1 -1
  87. package/dist/templates/mdx/platform/site-settings.mdx.js +8 -0
  88. package/dist/templates/mdx/platform/team-members.mdx.d.ts +1 -1
  89. package/dist/templates/mdx/platform/team-members.mdx.js +8 -0
  90. package/dist/templates/mdx/platform/theme-settings.mdx.d.ts +1 -1
  91. package/dist/templates/mdx/platform/theme-settings.mdx.js +7 -0
  92. package/dist/templates/mdx/sections.mdx.d.ts +1 -1
  93. package/dist/templates/mdx/sections.mdx.js +22 -1
  94. package/dist/templates/mdx/steps.mdx.d.ts +1 -1
  95. package/dist/templates/mdx/steps.mdx.js +7 -5
  96. package/dist/templates/mdx/tabs.mdx.d.ts +1 -1
  97. package/dist/templates/mdx/tabs.mdx.js +7 -2
  98. package/dist/templates/mdx/theme.mdx.d.ts +1 -1
  99. package/dist/templates/mdx/theme.mdx.js +10 -0
  100. package/dist/templates/mdx/update.mdx.d.ts +1 -1
  101. package/dist/templates/mdx/update.mdx.js +17 -14
  102. package/dist/templates/package.js +14 -14
  103. package/dist/templates/pnpmWorkspace.d.ts +1 -0
  104. package/dist/templates/pnpmWorkspace.js +7 -0
  105. package/package.json +6 -7
@@ -1 +1 @@
1
- export declare const platformBuildAndDeployMdxTemplate = "---\ntitle: \"Build & Deploy\"\ndescription: \"Monitor your documentation site's build status and deployment history.\"\ndate: \"2026-02-19\"\ncategory: \"Infrastructure\"\ncategoryOrder: 3\norder: 1\nsection: \"Platform\"\n---\n# Build & Deploy\nThe Build & Deploy page shows your documentation site's build and deployment history. Every time you publish changes or push to GitHub, a new deployment is created.\n\n## Deployment status\nThe project header always shows your current deployment status:\n\n- **Ready** - your site is live and up to date\n- **Building** - a new deployment is in progress\n- **Queued** - a deployment is waiting to start\n- **Error** - the build failed\n\n<Callout type=\"warning\">\n If a deployment fails, check the build logs for error details. Common issues include MDX syntax errors or missing frontmatter fields.\n</Callout>\n\n## Build logs\nClick on any deployment to view its build logs. These show the full output of the build process, making it easy to diagnose issues.\n\n## Deployment triggers\nDeployments are triggered in three ways:\n\n1. **Publishing from Doccupine** - clicking Publish in the project header\n2. **Pushing to GitHub** - pushing to the `main` branch of your repository triggers an automatic deploy via webhook\n3. **Configuration changes** - saving AI assistant settings triggers a redeploy since those are stored as environment variables\n\n## Visiting your site\nClick the **Visit** button in the project header to open your live documentation site in a new tab.";
1
+ export declare const platformBuildAndDeployMdxTemplate = "---\ntitle: \"Build & Deploy\"\ndescription: \"Monitor your documentation site's build status and deployment history.\"\ndate: \"2026-02-19\"\ncategory: \"Infrastructure\"\ncategoryOrder: 3\norder: 1\nsection: \"Platform\"\n---\n\n# Build & Deploy\n\nThe Build & Deploy page shows your documentation site's build and deployment history. Every time you publish changes or push to GitHub, a new deployment is created.\n\n## Deployment status\n\nThe project header always shows your current deployment status:\n\n- **Ready** - your site is live and up to date\n- **Building** - a new deployment is in progress\n- **Queued** - a deployment is waiting to start\n- **Error** - the build failed\n\n<Callout type=\"warning\">\n If a deployment fails, check the build logs for error details. Common issues include MDX syntax errors or missing frontmatter fields.\n</Callout>\n\n## Build logs\n\nClick on any deployment to view its build logs. These show the full output of the build process, making it easy to diagnose issues.\n\n## Deployment triggers\n\nDeployments are triggered in three ways:\n\n1. **Publishing from Doccupine** - clicking Publish in the project header\n2. **Pushing to GitHub** - pushing to the `main` branch of your repository triggers an automatic deploy via webhook\n3. **Configuration changes** - saving AI assistant settings triggers a redeploy since those are stored as environment variables\n\n## Visiting your site\n\nClick the **Visit** button in the project header to open your live documentation site in a new tab.";
@@ -7,10 +7,13 @@ categoryOrder: 3
7
7
  order: 1
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Build & Deploy
12
+
11
13
  The Build & Deploy page shows your documentation site's build and deployment history. Every time you publish changes or push to GitHub, a new deployment is created.
12
14
 
13
15
  ## Deployment status
16
+
14
17
  The project header always shows your current deployment status:
15
18
 
16
19
  - **Ready** - your site is live and up to date
@@ -23,9 +26,11 @@ The project header always shows your current deployment status:
23
26
  </Callout>
24
27
 
25
28
  ## Build logs
29
+
26
30
  Click on any deployment to view its build logs. These show the full output of the build process, making it easy to diagnose issues.
27
31
 
28
32
  ## Deployment triggers
33
+
29
34
  Deployments are triggered in three ways:
30
35
 
31
36
  1. **Publishing from Doccupine** - clicking Publish in the project header
@@ -33,4 +38,5 @@ Deployments are triggered in three ways:
33
38
  3. **Configuration changes** - saving AI assistant settings triggers a redeploy since those are stored as environment variables
34
39
 
35
40
  ## Visiting your site
41
+
36
42
  Click the **Visit** button in the project header to open your live documentation site in a new tab.`;
@@ -1 +1 @@
1
- export declare const platformCreatingAProjectMdxTemplate = "---\ntitle: \"Creating a Project\"\ndescription: \"Set up a new documentation project with a managed or user-connected GitHub repository.\"\ndate: \"2026-02-19\"\ncategory: \"Getting Started\"\ncategoryOrder: 0\norder: 1\nsection: \"Platform\"\n---\n# Creating a Project\nFrom your dashboard, click **Create new project** to get started. You'll name your project and choose how its Git repository is managed.\n\n## Repository modes\nDoccupine needs a GitHub repository to store your documentation files. You have two options:\n\n### Managed repository\nChoose **Use managed repository** and Doccupine creates and manages the GitHub repo for you under its own organization. This is the simplest option - no GitHub account required on your end.\n\n### User repository\nChoose **Connect to GitHub** to link your own GitHub account via OAuth. Doccupine creates the repo in your account, giving you full ownership and direct access to the source files.\n\n<Callout type=\"note\">\n You can connect your GitHub account at any time. If you're not sure, start with a managed repository - you can always migrate later.\n</Callout>\n\n## What happens during setup\nAfter you choose a repository mode, Doccupine runs an automated setup process:\n\n1. Creates a GitHub repository\n2. Commits a starter template with example documentation files\n3. Creates a hosting project on the deployment platform\n4. Runs the initial build and deployment\n5. Sets up a webhook so future pushes to the `main` branch trigger automatic deploys\n\nThis takes about a minute. Once complete, you're redirected to your new project's file explorer.\n\n<Callout type=\"success\">\n Your site is live immediately after setup. Visit it using the **Visit** button in the project header.\n</Callout>\n\n## Project limits\nThe number of projects you can create depends on your plan:\n\n- **Pro** - 1 project, up to 5 team members\n- **Enterprise** - 6 projects, unlimited team members\n\nIf you've reached your limit, you'll see a prompt to upgrade your plan.";
1
+ export declare const platformCreatingAProjectMdxTemplate = "---\ntitle: \"Creating a Project\"\ndescription: \"Set up a new documentation project with a managed or user-connected GitHub repository.\"\ndate: \"2026-02-19\"\ncategory: \"Getting Started\"\ncategoryOrder: 0\norder: 1\nsection: \"Platform\"\n---\n\n# Creating a Project\n\nFrom your dashboard, click **Create new project** to get started. You'll name your project and choose how its Git repository is managed.\n\n## Repository modes\n\nDoccupine needs a GitHub repository to store your documentation files. You have two options:\n\n### Managed repository\n\nChoose **Use managed repository** and Doccupine creates and manages the GitHub repo for you under its own organization. This is the simplest option - no GitHub account required on your end.\n\n### User repository\n\nChoose **Connect to GitHub** to link your own GitHub account via OAuth. Doccupine creates the repo in your account, giving you full ownership and direct access to the source files.\n\n<Callout type=\"note\">\n You can connect your GitHub account at any time. If you're not sure, start with a managed repository - you can always migrate later.\n</Callout>\n\n## What happens during setup\n\nAfter you choose a repository mode, Doccupine runs an automated setup process:\n\n1. Creates a GitHub repository\n2. Commits a starter template with example documentation files\n3. Creates a hosting project on the deployment platform\n4. Runs the initial build and deployment\n5. Sets up a webhook so future pushes to the `main` branch trigger automatic deploys\n\nThis takes about a minute. Once complete, you're redirected to your new project's file explorer.\n\n<Callout type=\"success\">\n Your site is live immediately after setup. Visit it using the **Visit** button in the project header.\n</Callout>\n\n## Project limits\n\nThe number of projects you can create depends on your plan:\n\n- **Pro** - 1 project, up to 5 team members\n- **Enterprise** - 6 projects, unlimited team members\n\nIf you've reached your limit, you'll see a prompt to upgrade your plan.";
@@ -7,16 +7,21 @@ categoryOrder: 0
7
7
  order: 1
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Creating a Project
12
+
11
13
  From your dashboard, click **Create new project** to get started. You'll name your project and choose how its Git repository is managed.
12
14
 
13
15
  ## Repository modes
16
+
14
17
  Doccupine needs a GitHub repository to store your documentation files. You have two options:
15
18
 
16
19
  ### Managed repository
20
+
17
21
  Choose **Use managed repository** and Doccupine creates and manages the GitHub repo for you under its own organization. This is the simplest option - no GitHub account required on your end.
18
22
 
19
23
  ### User repository
24
+
20
25
  Choose **Connect to GitHub** to link your own GitHub account via OAuth. Doccupine creates the repo in your account, giving you full ownership and direct access to the source files.
21
26
 
22
27
  <Callout type="note">
@@ -24,6 +29,7 @@ Choose **Connect to GitHub** to link your own GitHub account via OAuth. Doccupin
24
29
  </Callout>
25
30
 
26
31
  ## What happens during setup
32
+
27
33
  After you choose a repository mode, Doccupine runs an automated setup process:
28
34
 
29
35
  1. Creates a GitHub repository
@@ -39,6 +45,7 @@ This takes about a minute. Once complete, you're redirected to your new project'
39
45
  </Callout>
40
46
 
41
47
  ## Project limits
48
+
42
49
  The number of projects you can create depends on your plan:
43
50
 
44
51
  - **Pro** - 1 project, up to 5 team members
@@ -1 +1 @@
1
- export declare const platformCustomDomainsMdxTemplate = "---\ntitle: \"Custom Domains\"\ndescription: \"Connect your own domain to your documentation site with automatic HTTPS.\"\ndate: \"2026-02-19\"\ncategory: \"Infrastructure\"\ncategoryOrder: 3\norder: 0\nsection: \"Platform\"\n---\n# Custom Domains\nBy default, your documentation site is available at a `.doccupine.app` subdomain. You can connect your own custom domain for a branded experience.\n\n## Adding a domain\n\n1. Navigate to your project's **Domains** page from the sidebar.\n2. Enter your custom domain (e.g., `docs.yourcompany.com`).\n3. Click **Add Domain**.\n\nDoccupine will provide DNS records that you need to configure with your domain registrar.\n\n## DNS configuration\nAfter adding your domain, you'll see the required DNS records. Typically this involves adding a **CNAME** record pointing to your Doccupine deployment.\n\nConfigure the records with your domain registrar (Cloudflare, Namecheap, GoDaddy, Route 53, etc.) and return to the Domains page to check verification status.\n\n<Callout type=\"note\">\n DNS changes can take up to 48 hours to propagate, though most resolve within a few minutes.\n</Callout>\n\n## Verification\nDoccupine periodically checks whether your DNS records are configured correctly. The Domains page shows the current verification status. Once verified, your custom domain is active and serves your documentation with automatic HTTPS.\n\n## Removing a domain\nClick the remove button next to your domain to disconnect it. Your site will continue to be available at its `.doccupine.app` URL.";
1
+ export declare const platformCustomDomainsMdxTemplate = "---\ntitle: \"Custom Domains\"\ndescription: \"Connect your own domain to your documentation site with automatic HTTPS.\"\ndate: \"2026-02-19\"\ncategory: \"Infrastructure\"\ncategoryOrder: 3\norder: 0\nsection: \"Platform\"\n---\n\n# Custom Domains\n\nBy default, your documentation site is available at a `.doccupine.app` subdomain. You can connect your own custom domain for a branded experience.\n\n## Adding a domain\n\n1. Navigate to your project's **Domains** page from the sidebar.\n2. Enter your custom domain (e.g., `docs.yourcompany.com`).\n3. Click **Add Domain**.\n\nDoccupine will provide DNS records that you need to configure with your domain registrar.\n\n## DNS configuration\n\nAfter adding your domain, you'll see the required DNS records. Typically this involves adding a **CNAME** record pointing to your Doccupine deployment.\n\nConfigure the records with your domain registrar (Cloudflare, Namecheap, GoDaddy, Route 53, etc.) and return to the Domains page to check verification status.\n\n<Callout type=\"note\">\n DNS changes can take up to 48 hours to propagate, though most resolve within a few minutes.\n</Callout>\n\n## Verification\n\nDoccupine periodically checks whether your DNS records are configured correctly. The Domains page shows the current verification status. Once verified, your custom domain is active and serves your documentation with automatic HTTPS.\n\n## Removing a domain\n\nClick the remove button next to your domain to disconnect it. Your site will continue to be available at its `.doccupine.app` URL.";
@@ -7,7 +7,9 @@ categoryOrder: 3
7
7
  order: 0
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Custom Domains
12
+
11
13
  By default, your documentation site is available at a \`.doccupine.app\` subdomain. You can connect your own custom domain for a branded experience.
12
14
 
13
15
  ## Adding a domain
@@ -19,6 +21,7 @@ By default, your documentation site is available at a \`.doccupine.app\` subdoma
19
21
  Doccupine will provide DNS records that you need to configure with your domain registrar.
20
22
 
21
23
  ## DNS configuration
24
+
22
25
  After adding your domain, you'll see the required DNS records. Typically this involves adding a **CNAME** record pointing to your Doccupine deployment.
23
26
 
24
27
  Configure the records with your domain registrar (Cloudflare, Namecheap, GoDaddy, Route 53, etc.) and return to the Domains page to check verification status.
@@ -28,7 +31,9 @@ Configure the records with your domain registrar (Cloudflare, Namecheap, GoDaddy
28
31
  </Callout>
29
32
 
30
33
  ## Verification
34
+
31
35
  Doccupine periodically checks whether your DNS records are configured correctly. The Domains page shows the current verification status. Once verified, your custom domain is active and serves your documentation with automatic HTTPS.
32
36
 
33
37
  ## Removing a domain
38
+
34
39
  Click the remove button next to your domain to disconnect it. Your site will continue to be available at its \`.doccupine.app\` URL.`;
@@ -1 +1 @@
1
- export declare const platformExternalLinksMdxTemplate = "---\ntitle: \"External Links\"\ndescription: \"Add quick-access link buttons to your site's footer for GitHub, Discord, and other external resources.\"\ndate: \"2026-02-19\"\ncategory: \"Configuration\"\ncategoryOrder: 2\norder: 5\nsection: \"Platform\"\n---\n# External Links\nThe External Links settings page lets you add external link buttons to your documentation site's footer. These provide quick access to your project's GitHub repository, Discord server, social profiles, and other resources.\n\n## Adding a link\nClick **Add Link** and configure:\n\n- **Icon** (optional) - search and pick from any [Lucide](https://lucide.dev/) icon\n- **Title** - the display text for the link\n- **URL** - the target URL\n\n## Choosing an icon\nThe icon picker lets you search through the full [Lucide](https://lucide.dev/) icon set. Type a keyword to filter (e.g. \"git-branch\", \"mail\", \"globe\") and click to select.\n\nLeave the icon unset for a text-only link.\n\nIf you edit `links.json` directly, use Lucide icon names in kebab-case (e.g. `git-branch`, `message-circle`, `heart`).\n\n## How it works\nLink settings are stored in `links.json` at the root of your repository:\n\n```json\n[\n {\n \"title\": \"GitHub\",\n \"url\": \"https://github.com/your-org/your-repo\",\n \"icon\": \"git-branch\"\n },\n {\n \"title\": \"Discord\",\n \"url\": \"https://discord.gg/your-invite\",\n \"icon\": \"discord\"\n }\n]\n```";
1
+ export declare const platformExternalLinksMdxTemplate = "---\ntitle: \"External Links\"\ndescription: \"Add quick-access link buttons to your site's footer for GitHub, Discord, and other external resources.\"\ndate: \"2026-02-19\"\ncategory: \"Configuration\"\ncategoryOrder: 2\norder: 5\nsection: \"Platform\"\n---\n\n# External Links\n\nThe External Links settings page lets you add external link buttons to your documentation site's footer. These provide quick access to your project's GitHub repository, Discord server, social profiles, and other resources.\n\n## Adding a link\n\nClick **Add Link** and configure:\n\n- **Icon** (optional) - search and pick from any [Lucide](https://lucide.dev/) icon\n- **Title** - the display text for the link\n- **URL** - the target URL\n\n## Choosing an icon\n\nThe icon picker lets you search through the full [Lucide](https://lucide.dev/) icon set. Type a keyword to filter (e.g. \"git-branch\", \"mail\", \"globe\") and click to select.\n\nLeave the icon unset for a text-only link.\n\nIf you edit `links.json` directly, use Lucide icon names in kebab-case (e.g. `git-branch`, `message-circle`, `heart`).\n\n## How it works\n\nLink settings are stored in `links.json` at the root of your repository:\n\n```json\n[\n {\n \"title\": \"GitHub\",\n \"url\": \"https://github.com/your-org/your-repo\",\n \"icon\": \"git-branch\"\n },\n {\n \"title\": \"Discord\",\n \"url\": \"https://discord.gg/your-invite\",\n \"icon\": \"discord\"\n }\n]\n```";
@@ -7,10 +7,13 @@ categoryOrder: 2
7
7
  order: 5
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # External Links
12
+
11
13
  The External Links settings page lets you add external link buttons to your documentation site's footer. These provide quick access to your project's GitHub repository, Discord server, social profiles, and other resources.
12
14
 
13
15
  ## Adding a link
16
+
14
17
  Click **Add Link** and configure:
15
18
 
16
19
  - **Icon** (optional) - search and pick from any [Lucide](https://lucide.dev/) icon
@@ -18,6 +21,7 @@ Click **Add Link** and configure:
18
21
  - **URL** - the target URL
19
22
 
20
23
  ## Choosing an icon
24
+
21
25
  The icon picker lets you search through the full [Lucide](https://lucide.dev/) icon set. Type a keyword to filter (e.g. "git-branch", "mail", "globe") and click to select.
22
26
 
23
27
  Leave the icon unset for a text-only link.
@@ -25,6 +29,7 @@ Leave the icon unset for a text-only link.
25
29
  If you edit \`links.json\` directly, use Lucide icon names in kebab-case (e.g. \`git-branch\`, \`message-circle\`, \`heart\`).
26
30
 
27
31
  ## How it works
32
+
28
33
  Link settings are stored in \`links.json\` at the root of your repository:
29
34
 
30
35
  \`\`\`json
@@ -1 +1 @@
1
- export declare const platformFileEditorMdxTemplate = "---\ntitle: \"File Editor\"\ndescription: \"Browse, create, and edit your documentation files directly in the browser.\"\ndate: \"2026-02-19\"\ncategory: \"Editing\"\ncategoryOrder: 1\norder: 0\nsection: \"Platform\"\n---\n# File Editor\nThe file editor is the main workspace for your documentation project. It provides a browser-based file explorer and editor for working with your MDX files and assets.\n\n## File explorer\nThe left panel has three tabs:\n\n- **Files** - browse your repository's file tree, create and manage files and folders\n- **Media** - manage uploaded images and binary assets\n- **Navigation** - open the [Navigation Builder](/platform/navigation-settings) to configure your sidebar structure with drag-and-drop\n\nIn the Files tab, you can:\n\n- **Browse** directories and files\n- **Create** new files and folders\n- **Rename** and **delete** existing files\n- **Upload** binary assets like images, favicons, and font files\n\nClick any file to open it in the editor panel.\n\n## Editing files\nThe editor supports MDX files with full syntax highlighting. Changes you make are saved as **pending changes** - they aren't committed to your repository until you publish.\n\n<Callout type=\"note\">\n Pending changes are stored in Doccupine's database, not in your Git repository. This means you can make edits across multiple sessions before publishing.\n</Callout>\n\n## Version history\nFor any file, you can view its commit history to see how it has changed over time. This lets you:\n\n- See when changes were made and what the commit messages were\n- View the file's content at any previous commit\n- Compare past versions to understand what changed\n\n## Binary files\nYou can upload images and other binary assets (PNG, JPG, SVG, WOFF2, etc.) directly through the file explorer. These are stored temporarily in Doccupine's storage and committed to your repository when you publish.\n\n## Read-only mode\nTeam members with the **Viewer** or **Billing** role can browse files but cannot make edits. The editor will display content in read-only mode for these users.";
1
+ export declare const platformFileEditorMdxTemplate = "---\ntitle: \"File Editor\"\ndescription: \"Browse, create, and edit your documentation files directly in the browser.\"\ndate: \"2026-02-19\"\ncategory: \"Editing\"\ncategoryOrder: 1\norder: 0\nsection: \"Platform\"\n---\n\n# File Editor\n\nThe file editor is the main workspace for your documentation project. It provides a browser-based file explorer and editor for working with your MDX files and assets.\n\n## File explorer\n\nThe left panel has three tabs:\n\n- **Files** - browse your repository's file tree, create and manage files and folders\n- **Media** - manage uploaded images and binary assets\n- **Navigation** - open the [Navigation Builder](/platform/navigation-settings) to configure your sidebar structure with drag-and-drop\n\nIn the Files tab, you can:\n\n- **Browse** directories and files\n- **Create** new files and folders\n- **Rename** and **delete** existing files\n- **Upload** binary assets like images, favicons, and font files\n\nClick any file to open it in the editor panel.\n\n## Editing files\n\nThe editor supports MDX files with full syntax highlighting. Changes you make are saved as **pending changes** - they aren't committed to your repository until you publish.\n\n<Callout type=\"note\">\n Pending changes are stored in Doccupine's database, not in your Git repository. This means you can make edits across multiple sessions before publishing.\n</Callout>\n\n## Version history\n\nFor any file, you can view its commit history to see how it has changed over time. This lets you:\n\n- See when changes were made and what the commit messages were\n- View the file's content at any previous commit\n- Compare past versions to understand what changed\n\n## Binary files\n\nYou can upload images and other binary assets (PNG, JPG, SVG, WOFF2, etc.) directly through the file explorer. These are stored temporarily in Doccupine's storage and committed to your repository when you publish.\n\n## Read-only mode\n\nTeam members with the **Viewer** or **Billing** role can browse files but cannot make edits. The editor will display content in read-only mode for these users.";
@@ -7,10 +7,13 @@ categoryOrder: 1
7
7
  order: 0
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # File Editor
12
+
11
13
  The file editor is the main workspace for your documentation project. It provides a browser-based file explorer and editor for working with your MDX files and assets.
12
14
 
13
15
  ## File explorer
16
+
14
17
  The left panel has three tabs:
15
18
 
16
19
  - **Files** - browse your repository's file tree, create and manage files and folders
@@ -27,6 +30,7 @@ In the Files tab, you can:
27
30
  Click any file to open it in the editor panel.
28
31
 
29
32
  ## Editing files
33
+
30
34
  The editor supports MDX files with full syntax highlighting. Changes you make are saved as **pending changes** - they aren't committed to your repository until you publish.
31
35
 
32
36
  <Callout type="note">
@@ -34,6 +38,7 @@ The editor supports MDX files with full syntax highlighting. Changes you make ar
34
38
  </Callout>
35
39
 
36
40
  ## Version history
41
+
37
42
  For any file, you can view its commit history to see how it has changed over time. This lets you:
38
43
 
39
44
  - See when changes were made and what the commit messages were
@@ -41,7 +46,9 @@ For any file, you can view its commit history to see how it has changed over tim
41
46
  - Compare past versions to understand what changed
42
47
 
43
48
  ## Binary files
49
+
44
50
  You can upload images and other binary assets (PNG, JPG, SVG, WOFF2, etc.) directly through the file explorer. These are stored temporarily in Doccupine's storage and committed to your repository when you publish.
45
51
 
46
52
  ## Read-only mode
53
+
47
54
  Team members with the **Viewer** or **Billing** role can browse files but cannot make edits. The editor will display content in read-only mode for these users.`;
@@ -1 +1 @@
1
- export declare const platformFontsSettingsMdxTemplate = "---\ntitle: \"Fonts Settings\"\ndescription: \"Configure custom typography with Google Fonts or local font files.\"\ndate: \"2026-02-19\"\ncategory: \"Configuration\"\ncategoryOrder: 2\norder: 4\nsection: \"Platform\"\n---\n# Fonts Settings\nThe Fonts settings page lets you customize your documentation site's typography using Google Fonts or locally uploaded font files.\n\n## Google Fonts\nSelect a font from the full Google Fonts library:\n\n1. Type a font name to search the library.\n2. Select the **weights** you need (e.g., 400 for regular, 700 for bold). You can select multiple weights.\n3. Choose **subsets** for language support (latin, cyrillic, greek, vietnamese, etc.).\n\n<Callout type=\"note\">\n Only include the weights and subsets you actually use. Each addition increases page load time.\n</Callout>\n\n## Local fonts\nUpload your own font files for complete typographic control:\n\n1. Click **Add Font Source** to add a font file entry.\n2. Upload a font file (WOFF2, WOFF, TTF, OTF, or EOT format).\n3. Set the **weight** (e.g., 400, 700) and **style** (normal or italic).\n4. Add more sources for additional weights and styles.\n\nWOFF2 is recommended for the best compression and browser support.\n\n## How it works\nFont settings are stored in `fonts.json` at the root of your repository. Here's an example using Google Fonts:\n\n```json\n{\n \"googleFont\": {\n \"fontName\": \"Inter\",\n \"subsets\": [\"latin\"],\n \"weight\": [\"400\", \"500\", \"600\", \"700\"]\n }\n}\n```\n\nSee the [Fonts](/fonts) page for the full configuration format, including local font support.";
1
+ export declare const platformFontsSettingsMdxTemplate = "---\ntitle: \"Fonts Settings\"\ndescription: \"Configure custom typography with Google Fonts or local font files.\"\ndate: \"2026-02-19\"\ncategory: \"Configuration\"\ncategoryOrder: 2\norder: 4\nsection: \"Platform\"\n---\n\n# Fonts Settings\n\nThe Fonts settings page lets you customize your documentation site's typography using Google Fonts or locally uploaded font files.\n\n## Google Fonts\n\nSelect a font from the full Google Fonts library:\n\n1. Type a font name to search the library.\n2. Select the **weights** you need (e.g., 400 for regular, 700 for bold). You can select multiple weights.\n3. Choose **subsets** for language support (latin, cyrillic, greek, vietnamese, etc.).\n\n<Callout type=\"note\">\n Only include the weights and subsets you actually use. Each addition increases page load time.\n</Callout>\n\n## Local fonts\n\nUpload your own font files for complete typographic control:\n\n1. Click **Add Font Source** to add a font file entry.\n2. Upload a font file (WOFF2, WOFF, TTF, OTF, or EOT format).\n3. Set the **weight** (e.g., 400, 700) and **style** (normal or italic).\n4. Add more sources for additional weights and styles.\n\nWOFF2 is recommended for the best compression and browser support.\n\n## How it works\n\nFont settings are stored in `fonts.json` at the root of your repository. Here's an example using Google Fonts:\n\n```json\n{\n \"googleFont\": {\n \"fontName\": \"Inter\",\n \"subsets\": [\"latin\"],\n \"weight\": [\"400\", \"500\", \"600\", \"700\"]\n }\n}\n```\n\nSee the [Fonts](/fonts) page for the full configuration format, including local font support.";
@@ -7,10 +7,13 @@ categoryOrder: 2
7
7
  order: 4
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Fonts Settings
12
+
11
13
  The Fonts settings page lets you customize your documentation site's typography using Google Fonts or locally uploaded font files.
12
14
 
13
15
  ## Google Fonts
16
+
14
17
  Select a font from the full Google Fonts library:
15
18
 
16
19
  1. Type a font name to search the library.
@@ -22,6 +25,7 @@ Select a font from the full Google Fonts library:
22
25
  </Callout>
23
26
 
24
27
  ## Local fonts
28
+
25
29
  Upload your own font files for complete typographic control:
26
30
 
27
31
  1. Click **Add Font Source** to add a font file entry.
@@ -32,6 +36,7 @@ Upload your own font files for complete typographic control:
32
36
  WOFF2 is recommended for the best compression and browser support.
33
37
 
34
38
  ## How it works
39
+
35
40
  Font settings are stored in \`fonts.json\` at the root of your repository. Here's an example using Google Fonts:
36
41
 
37
42
  \`\`\`json
@@ -1 +1 @@
1
- export declare const platformIndexMdxTemplate = "---\ntitle: \"Platform Overview\"\ndescription: \"Learn how to use the Doccupine platform to create, customize, and deploy documentation websites.\"\ndate: \"2026-02-19\"\ncategory: \"Getting Started\"\ncategoryOrder: 0\norder: 0\nsection: \"Platform\"\n---\n# Platform Overview\nThe Doccupine platform gives you everything you need to create, customize, and host beautiful documentation websites - all from your browser. No local setup, no CI pipelines, no infrastructure to manage.\n\n## What you get\n- **Browser-based editor** for writing and managing your documentation files\n- **One-click publishing** that commits to GitHub and deploys automatically\n- **Visual configuration** for themes, navigation, fonts, links, and more\n- **Custom domains** with automatic HTTPS\n- **AI assistant** built into every deployed site\n- **Team collaboration** with role-based access control\n\n## How it works\nDoccupine connects two core pieces behind the scenes:\n\n1. **GitHub** stores your documentation source files in a Git repository\n2. **Doccupine** builds, hosts, and serves your site globally - plus provides a dashboard for editing, configuring, and managing your project\n\nYou write MDX files, configure your site through visual settings pages, and hit Publish. Doccupine handles the rest.\n\n## Getting started\n\n1. **Sign up** at Doccupine and start your free 30-day trial - no credit card required.\n2. **Create a project** from the dashboard. Choose between a managed repository or connecting your own GitHub account.\n3. **Edit your docs** using the built-in file explorer and editor.\n4. **Configure your site** through the settings pages - theme, navigation, fonts, and more.\n5. **Publish** your changes with a single click.\n\n<Callout type=\"success\">\n Your documentation site is live the moment you create a project. Doccupine deploys a starter site automatically so you can see results immediately.\n</Callout>\n\n## Dashboard\nAfter signing in, the dashboard shows all your projects. You'll see two sections:\n\n- **Your Projects** - documentation sites you own, plus a button to create new ones\n- **Shared Projects** - sites that other users have invited you to collaborate on\n\nClick any project card to open it and start working.\n\n<Columns cols={2}>\n <Card title=\"Sign Up\" icon=\"user-plus\" href=\"https://doccupine.com/sign-up\">\n Create your free account and start building documentation in minutes.\n </Card>\n <Card title=\"Sign In\" icon=\"log-in\" href=\"https://doccupine.com/sign-in\">\n Already have an account? Sign in to your dashboard.\n </Card>\n</Columns>";
1
+ export declare const platformIndexMdxTemplate = "---\ntitle: \"Platform Overview\"\ndescription: \"Learn how to use the Doccupine platform to create, customize, and deploy documentation websites.\"\ndate: \"2026-02-19\"\ncategory: \"Getting Started\"\ncategoryOrder: 0\norder: 0\nsection: \"Platform\"\n---\n\n# Platform Overview\n\nThe Doccupine platform gives you everything you need to create, customize, and host beautiful documentation websites - all from your browser. No local setup, no CI pipelines, no infrastructure to manage.\n\n## What you get\n\n- **Browser-based editor** for writing and managing your documentation files\n- **One-click publishing** that commits to GitHub and deploys automatically\n- **Visual configuration** for themes, navigation, fonts, links, and more\n- **Custom domains** with automatic HTTPS\n- **AI assistant** built into every deployed site\n- **Team collaboration** with role-based access control\n\n## How it works\n\nDoccupine connects two core pieces behind the scenes:\n\n1. **GitHub** stores your documentation source files in a Git repository\n2. **Doccupine** builds, hosts, and serves your site globally - plus provides a dashboard for editing, configuring, and managing your project\n\nYou write MDX files, configure your site through visual settings pages, and hit Publish. Doccupine handles the rest.\n\n## Getting started\n\n1. **Sign up** at Doccupine and start your free 30-day trial - no credit card required.\n2. **Create a project** from the dashboard. Choose between a managed repository or connecting your own GitHub account.\n3. **Edit your docs** using the built-in file explorer and editor.\n4. **Configure your site** through the settings pages - theme, navigation, fonts, and more.\n5. **Publish** your changes with a single click.\n\n<Callout type=\"success\">\n Your documentation site is live the moment you create a project. Doccupine deploys a starter site automatically so you can see results immediately.\n</Callout>\n\n## Dashboard\n\nAfter signing in, the dashboard shows all your projects. You'll see two sections:\n\n- **Your Projects** - documentation sites you own, plus a button to create new ones\n- **Shared Projects** - sites that other users have invited you to collaborate on\n\nClick any project card to open it and start working.\n\n<Columns cols={2}>\n <Card title=\"Sign Up\" icon=\"user-plus\" href=\"https://doccupine.com/sign-up\">\n Create your free account and start building documentation in minutes.\n </Card>\n <Card title=\"Sign In\" icon=\"log-in\" href=\"https://doccupine.com/sign-in\">\n Already have an account? Sign in to your dashboard.\n </Card>\n</Columns>";
@@ -7,10 +7,13 @@ categoryOrder: 0
7
7
  order: 0
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Platform Overview
12
+
11
13
  The Doccupine platform gives you everything you need to create, customize, and host beautiful documentation websites - all from your browser. No local setup, no CI pipelines, no infrastructure to manage.
12
14
 
13
15
  ## What you get
16
+
14
17
  - **Browser-based editor** for writing and managing your documentation files
15
18
  - **One-click publishing** that commits to GitHub and deploys automatically
16
19
  - **Visual configuration** for themes, navigation, fonts, links, and more
@@ -19,6 +22,7 @@ The Doccupine platform gives you everything you need to create, customize, and h
19
22
  - **Team collaboration** with role-based access control
20
23
 
21
24
  ## How it works
25
+
22
26
  Doccupine connects two core pieces behind the scenes:
23
27
 
24
28
  1. **GitHub** stores your documentation source files in a Git repository
@@ -39,6 +43,7 @@ You write MDX files, configure your site through visual settings pages, and hit
39
43
  </Callout>
40
44
 
41
45
  ## Dashboard
46
+
42
47
  After signing in, the dashboard shows all your projects. You'll see two sections:
43
48
 
44
49
  - **Your Projects** - documentation sites you own, plus a button to create new ones
@@ -1 +1 @@
1
- export declare const platformNavigationSettingsMdxTemplate = "---\ntitle: \"Navigation Settings\"\ndescription: \"Define the sidebar structure for your documentation site using the drag-and-drop Navigation Builder.\"\ndate: \"2026-02-24\"\ncategory: \"Configuration\"\ncategoryOrder: 2\norder: 2\nsection: \"Platform\"\n---\n# Navigation Settings\nThe Navigation Builder lets you define your sidebar structure through a visual, drag-and-drop interface. It lives inside the **File Explorer** as a dedicated **Navigation** tab, alongside the Files and Media tabs.\n\n## Structure\nNavigation is organized into three levels:\n\n- **Section** - a top-level area of your site (e.g., \"Docs\", \"API Reference\"). Each section appears as a tab below the site header and has its own sidebar. Sections are defined by a label, URL slug, and docs directory.\n- **Category** - a group label within a section's sidebar (e.g., \"Getting Started\")\n- **Link** - an individual page entry within a category, defined by a slug and title\n\n## Drag-and-drop reordering\nYou can reorder items at every level by dragging their handles:\n\n- **Drag categories** between sections or within the same section to change their position\n- **Drag links** between categories or within the same category to reorder them\n\n## Managing sections\n- Click **Add Section** in the toolbar to create a new section. Fill in the label, slug, and directory fields.\n- Click the **edit** button on a section header to open its edit modal, where you can update the label, slug, and directory.\n- Delete a section from its edit modal using the delete button. The root section cannot be deleted.\n\n### The default section\nOne section should have an empty slug (`\"\"`). This is the default/root section that serves pages at the root URL. Pages not assigned to any other section belong here.\n\n### Frontmatter-based sections\nYou can also define sections purely through page frontmatter without using the Navigation Builder. Add a `section` field to your MDX frontmatter and Doccupine will create sections automatically. See the [Sections documentation](/sections) for details.\n\n## Managing categories\n- Click **Add Category** within a section to create a new group\n- Click the **edit** button on a category to open its edit modal, where you can rename it or delete it\n\n## Adding links\nWithin each category, click **Add files** to open a popover that lists available MDX files not yet included in the navigation. You can:\n\n- **Search** by file name to filter the list\n- **Select** one or more files using checkboxes\n- Click **Add** to insert them as links in the category\n\nTo remove a link, click the **delete** button next to it.\n\n## Regenerate from files\nThe toolbar includes a **Regenerate** button that rebuilds the entire navigation tree from your MDX files' frontmatter (`category`, `categoryOrder`, and `order` fields). A confirmation modal appears before any existing manual navigation is replaced.\n\n<Callout type=\"warning\">\n Regenerating from files replaces your current navigation structure. This cannot be undone.\n</Callout>\n\n## Auto-generated vs. manual\nIf you don't configure navigation at all, Doccupine automatically builds your sidebar from page frontmatter. The Navigation Builder is only needed when you want explicit control over the order and grouping.\n\n## How it works\nWhen you save, the Navigation Builder writes two files to your repository as pending changes:\n\n- `navigation.json` - the category and link structure for each section\n- `sections.json` - the list of sections with their labels, slugs, and directories\n\n**Array format** for single-section sites (`navigation.json`):\n```json\n[\n {\n \"label\": \"Getting Started\",\n \"links\": [\n { \"slug\": \"getting-started\", \"title\": \"Quick Start\" }\n ]\n }\n]\n```\n\n**Object format** for multi-section sites (`navigation.json`):\n```json\n{\n \"\": [\n { \"label\": \"General\", \"links\": [{ \"slug\": \"\", \"title\": \"Introduction\" }] }\n ],\n \"api\": [\n { \"label\": \"Auth\", \"links\": [{ \"slug\": \"api/auth\", \"title\": \"Authentication\" }] }\n ]\n}\n```\n\n**Sections** (`sections.json`):\n```json\n[\n { \"label\": \"Docs\", \"slug\": \"\" },\n { \"label\": \"API Reference\", \"slug\": \"api\" }\n]\n```";
1
+ export declare const platformNavigationSettingsMdxTemplate = "---\ntitle: \"Navigation Settings\"\ndescription: \"Define the sidebar structure for your documentation site using the drag-and-drop Navigation Builder.\"\ndate: \"2026-02-24\"\ncategory: \"Configuration\"\ncategoryOrder: 2\norder: 2\nsection: \"Platform\"\n---\n\n# Navigation Settings\n\nThe Navigation Builder lets you define your sidebar structure through a visual, drag-and-drop interface. It lives inside the **File Explorer** as a dedicated **Navigation** tab, alongside the Files and Media tabs.\n\n## Structure\n\nNavigation is organized into three levels:\n\n- **Section** - a top-level area of your site (e.g., \"Docs\", \"API Reference\"). Each section appears as a tab below the site header and has its own sidebar. Sections are defined by a label, URL slug, and docs directory.\n- **Category** - a group label within a section's sidebar (e.g., \"Getting Started\")\n- **Link** - an individual page entry within a category, defined by a slug and title\n\n## Drag-and-drop reordering\n\nYou can reorder items at every level by dragging their handles:\n\n- **Drag categories** between sections or within the same section to change their position\n- **Drag links** between categories or within the same category to reorder them\n\n## Managing sections\n\n- Click **Add Section** in the toolbar to create a new section. Fill in the label, slug, and directory fields.\n- Click the **edit** button on a section header to open its edit modal, where you can update the label, slug, and directory.\n- Delete a section from its edit modal using the delete button. The root section cannot be deleted.\n\n### The default section\n\nOne section should have an empty slug (`\"\"`). This is the default/root section that serves pages at the root URL. Pages not assigned to any other section belong here.\n\n### Frontmatter-based sections\n\nYou can also define sections purely through page frontmatter without using the Navigation Builder. Add a `section` field to your MDX frontmatter and Doccupine will create sections automatically. See the [Sections documentation](/sections) for details.\n\n## Managing categories\n\n- Click **Add Category** within a section to create a new group\n- Click the **edit** button on a category to open its edit modal, where you can rename it or delete it\n\n## Adding links\n\nWithin each category, click **Add files** to open a popover that lists available MDX files not yet included in the navigation. You can:\n\n- **Search** by file name to filter the list\n- **Select** one or more files using checkboxes\n- Click **Add** to insert them as links in the category\n\nTo remove a link, click the **delete** button next to it.\n\n## Regenerate from files\n\nThe toolbar includes a **Regenerate** button that rebuilds the entire navigation tree from your MDX files' frontmatter (`category`, `categoryOrder`, and `order` fields). A confirmation modal appears before any existing manual navigation is replaced.\n\n<Callout type=\"warning\">\n Regenerating from files replaces your current navigation structure. This cannot be undone.\n</Callout>\n\n## Auto-generated vs. manual\n\nIf you don't configure navigation at all, Doccupine automatically builds your sidebar from page frontmatter. The Navigation Builder is only needed when you want explicit control over the order and grouping.\n\n## How it works\n\nWhen you save, the Navigation Builder writes two files to your repository as pending changes:\n\n- `navigation.json` - the category and link structure for each section\n- `sections.json` - the list of sections with their labels, slugs, and directories\n\n**Array format** for single-section sites (`navigation.json`):\n\n```json\n[\n {\n \"label\": \"Getting Started\",\n \"links\": [{ \"slug\": \"getting-started\", \"title\": \"Quick Start\" }]\n }\n]\n```\n\n**Object format** for multi-section sites (`navigation.json`):\n\n```json\n{\n \"\": [\n { \"label\": \"General\", \"links\": [{ \"slug\": \"\", \"title\": \"Introduction\" }] }\n ],\n \"api\": [\n {\n \"label\": \"Auth\",\n \"links\": [{ \"slug\": \"api/auth\", \"title\": \"Authentication\" }]\n }\n ]\n}\n```\n\n**Sections** (`sections.json`):\n\n```json\n[\n { \"label\": \"Docs\", \"slug\": \"\" },\n { \"label\": \"API Reference\", \"slug\": \"api\" }\n]\n```";
@@ -7,10 +7,13 @@ categoryOrder: 2
7
7
  order: 2
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Navigation Settings
12
+
11
13
  The Navigation Builder lets you define your sidebar structure through a visual, drag-and-drop interface. It lives inside the **File Explorer** as a dedicated **Navigation** tab, alongside the Files and Media tabs.
12
14
 
13
15
  ## Structure
16
+
14
17
  Navigation is organized into three levels:
15
18
 
16
19
  - **Section** - a top-level area of your site (e.g., "Docs", "API Reference"). Each section appears as a tab below the site header and has its own sidebar. Sections are defined by a label, URL slug, and docs directory.
@@ -18,27 +21,33 @@ Navigation is organized into three levels:
18
21
  - **Link** - an individual page entry within a category, defined by a slug and title
19
22
 
20
23
  ## Drag-and-drop reordering
24
+
21
25
  You can reorder items at every level by dragging their handles:
22
26
 
23
27
  - **Drag categories** between sections or within the same section to change their position
24
28
  - **Drag links** between categories or within the same category to reorder them
25
29
 
26
30
  ## Managing sections
31
+
27
32
  - Click **Add Section** in the toolbar to create a new section. Fill in the label, slug, and directory fields.
28
33
  - Click the **edit** button on a section header to open its edit modal, where you can update the label, slug, and directory.
29
34
  - Delete a section from its edit modal using the delete button. The root section cannot be deleted.
30
35
 
31
36
  ### The default section
37
+
32
38
  One section should have an empty slug (\`""\`). This is the default/root section that serves pages at the root URL. Pages not assigned to any other section belong here.
33
39
 
34
40
  ### Frontmatter-based sections
41
+
35
42
  You can also define sections purely through page frontmatter without using the Navigation Builder. Add a \`section\` field to your MDX frontmatter and Doccupine will create sections automatically. See the [Sections documentation](/sections) for details.
36
43
 
37
44
  ## Managing categories
45
+
38
46
  - Click **Add Category** within a section to create a new group
39
47
  - Click the **edit** button on a category to open its edit modal, where you can rename it or delete it
40
48
 
41
49
  ## Adding links
50
+
42
51
  Within each category, click **Add files** to open a popover that lists available MDX files not yet included in the navigation. You can:
43
52
 
44
53
  - **Search** by file name to filter the list
@@ -48,6 +57,7 @@ Within each category, click **Add files** to open a popover that lists available
48
57
  To remove a link, click the **delete** button next to it.
49
58
 
50
59
  ## Regenerate from files
60
+
51
61
  The toolbar includes a **Regenerate** button that rebuilds the entire navigation tree from your MDX files' frontmatter (\`category\`, \`categoryOrder\`, and \`order\` fields). A confirmation modal appears before any existing manual navigation is replaced.
52
62
 
53
63
  <Callout type="warning">
@@ -55,39 +65,45 @@ The toolbar includes a **Regenerate** button that rebuilds the entire navigation
55
65
  </Callout>
56
66
 
57
67
  ## Auto-generated vs. manual
68
+
58
69
  If you don't configure navigation at all, Doccupine automatically builds your sidebar from page frontmatter. The Navigation Builder is only needed when you want explicit control over the order and grouping.
59
70
 
60
71
  ## How it works
72
+
61
73
  When you save, the Navigation Builder writes two files to your repository as pending changes:
62
74
 
63
75
  - \`navigation.json\` - the category and link structure for each section
64
76
  - \`sections.json\` - the list of sections with their labels, slugs, and directories
65
77
 
66
78
  **Array format** for single-section sites (\`navigation.json\`):
79
+
67
80
  \`\`\`json
68
81
  [
69
82
  {
70
83
  "label": "Getting Started",
71
- "links": [
72
- { "slug": "getting-started", "title": "Quick Start" }
73
- ]
84
+ "links": [{ "slug": "getting-started", "title": "Quick Start" }]
74
85
  }
75
86
  ]
76
87
  \`\`\`
77
88
 
78
89
  **Object format** for multi-section sites (\`navigation.json\`):
90
+
79
91
  \`\`\`json
80
92
  {
81
93
  "": [
82
94
  { "label": "General", "links": [{ "slug": "", "title": "Introduction" }] }
83
95
  ],
84
96
  "api": [
85
- { "label": "Auth", "links": [{ "slug": "api/auth", "title": "Authentication" }] }
97
+ {
98
+ "label": "Auth",
99
+ "links": [{ "slug": "api/auth", "title": "Authentication" }]
100
+ }
86
101
  ]
87
102
  }
88
103
  \`\`\`
89
104
 
90
105
  **Sections** (\`sections.json\`):
106
+
91
107
  \`\`\`json
92
108
  [
93
109
  { "label": "Docs", "slug": "" },
@@ -1 +1 @@
1
- export declare const platformProjectSettingsMdxTemplate = "---\ntitle: \"Project Settings\"\ndescription: \"Rename or delete your documentation project.\"\ndate: \"2026-02-19\"\ncategory: \"Account\"\ncategoryOrder: 4\norder: 2\nsection: \"Platform\"\n---\n# Project Settings\nThe Project settings page provides basic project management options including renaming and deletion.\n\n## Renaming a project\nEnter a new name for your project and click **Save**. The project name is used in the dashboard and sidebar - it does not affect your site's URL or domain.\n\n## Deleting a project\n\n<Callout type=\"warning\">\n Deleting a project is permanent and cannot be undone.\n</Callout>\n\nTo delete a project:\n\n1. Navigate to the **Project** settings page.\n2. In the **Danger Zone** section, click **Delete Project**.\n3. Type your project's name to confirm.\n4. Click **Delete**.\n\nDeletion removes:\n- The GitHub repository (if managed by Doccupine)\n- The hosted deployment\n- All pending changes\n- All team member associations\n- The project record\n\nIf you're using a user-connected GitHub repository, the repo in your GitHub account is preserved - only the Doccupine project and its deployment are removed.";
1
+ export declare const platformProjectSettingsMdxTemplate = "---\ntitle: \"Project Settings\"\ndescription: \"Rename or delete your documentation project.\"\ndate: \"2026-02-19\"\ncategory: \"Account\"\ncategoryOrder: 4\norder: 2\nsection: \"Platform\"\n---\n\n# Project Settings\n\nThe Project settings page provides basic project management options including renaming and deletion.\n\n## Renaming a project\n\nEnter a new name for your project and click **Save**. The project name is used in the dashboard and sidebar - it does not affect your site's URL or domain.\n\n## Deleting a project\n\n<Callout type=\"warning\">\n Deleting a project is permanent and cannot be undone.\n</Callout>\n\nTo delete a project:\n\n1. Navigate to the **Project** settings page.\n2. In the **Danger Zone** section, click **Delete Project**.\n3. Type your project's name to confirm.\n4. Click **Delete**.\n\nDeletion removes:\n\n- The GitHub repository (if managed by Doccupine)\n- The hosted deployment\n- All pending changes\n- All team member associations\n- The project record\n\nIf you're using a user-connected GitHub repository, the repo in your GitHub account is preserved - only the Doccupine project and its deployment are removed.";
@@ -7,10 +7,13 @@ categoryOrder: 4
7
7
  order: 2
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Project Settings
12
+
11
13
  The Project settings page provides basic project management options including renaming and deletion.
12
14
 
13
15
  ## Renaming a project
16
+
14
17
  Enter a new name for your project and click **Save**. The project name is used in the dashboard and sidebar - it does not affect your site's URL or domain.
15
18
 
16
19
  ## Deleting a project
@@ -27,6 +30,7 @@ To delete a project:
27
30
  4. Click **Delete**.
28
31
 
29
32
  Deletion removes:
33
+
30
34
  - The GitHub repository (if managed by Doccupine)
31
35
  - The hosted deployment
32
36
  - All pending changes
@@ -1 +1 @@
1
- export declare const platformPublishingMdxTemplate = "---\ntitle: \"Publishing Changes\"\ndescription: \"Commit your edits to GitHub and deploy your documentation site with one click.\"\ndate: \"2026-02-19\"\ncategory: \"Editing\"\ncategoryOrder: 1\norder: 1\nsection: \"Platform\"\n---\n# Publishing Changes\nWhen you edit files in Doccupine, your changes are staged as pending. Nothing goes live until you explicitly publish.\n\n## The publish workflow\n\n1. Make edits to your files using the file editor.\n2. Click the **Publish** button in the project header. A badge shows the number of pending changes.\n3. Review the list of modified, deleted, and new files in the publish modal.\n4. Optionally write a custom commit message (defaults to \"Update docs via Doccupine\").\n5. Click **Publish Changes**.\n\nDoccupine then:\n- Commits all pending changes to your GitHub repository\n- Triggers a new deployment\n- Clears all pending changes from the staging area\n\n<Callout type=\"note\">\n The deployment status badge in the project header updates as your site builds. It cycles through **queued**, **building**, and **ready** (or **error** if something went wrong).\n</Callout>\n\n## Discarding changes\nIf you want to undo your pending edits, click **Discard All Changes** in the publish modal. This removes all staged changes without committing anything.\n\n## File status badges\nIn the publish modal, each file shows a badge indicating what changed:\n\n- **mod** - the file was modified\n- **del** - the file was deleted\n- **bin** - the file is a binary asset (image, font, etc.)\n\n## Auto-deploy from GitHub\nIf you're using a user-connected GitHub repository and push changes directly (outside of Doccupine), the webhook triggers an automatic redeploy. This means you can use Doccupine's editor and Git-based workflows interchangeably.";
1
+ export declare const platformPublishingMdxTemplate = "---\ntitle: \"Publishing Changes\"\ndescription: \"Commit your edits to GitHub and deploy your documentation site with one click.\"\ndate: \"2026-02-19\"\ncategory: \"Editing\"\ncategoryOrder: 1\norder: 1\nsection: \"Platform\"\n---\n\n# Publishing Changes\n\nWhen you edit files in Doccupine, your changes are staged as pending. Nothing goes live until you explicitly publish.\n\n## The publish workflow\n\n1. Make edits to your files using the file editor.\n2. Click the **Publish** button in the project header. A badge shows the number of pending changes.\n3. Review the list of modified, deleted, and new files in the publish modal.\n4. Optionally write a custom commit message (defaults to \"Update docs via Doccupine\").\n5. Click **Publish Changes**.\n\nDoccupine then:\n\n- Commits all pending changes to your GitHub repository\n- Triggers a new deployment\n- Clears all pending changes from the staging area\n\n<Callout type=\"note\">\n The deployment status badge in the project header updates as your site builds. It cycles through **queued**, **building**, and **ready** (or **error** if something went wrong).\n</Callout>\n\n## Discarding changes\n\nIf you want to undo your pending edits, click **Discard All Changes** in the publish modal. This removes all staged changes without committing anything.\n\n## File status badges\n\nIn the publish modal, each file shows a badge indicating what changed:\n\n- **mod** - the file was modified\n- **del** - the file was deleted\n- **bin** - the file is a binary asset (image, font, etc.)\n\n## Auto-deploy from GitHub\n\nIf you're using a user-connected GitHub repository and push changes directly (outside of Doccupine), the webhook triggers an automatic redeploy. This means you can use Doccupine's editor and Git-based workflows interchangeably.";
@@ -7,7 +7,9 @@ categoryOrder: 1
7
7
  order: 1
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Publishing Changes
12
+
11
13
  When you edit files in Doccupine, your changes are staged as pending. Nothing goes live until you explicitly publish.
12
14
 
13
15
  ## The publish workflow
@@ -19,6 +21,7 @@ When you edit files in Doccupine, your changes are staged as pending. Nothing go
19
21
  5. Click **Publish Changes**.
20
22
 
21
23
  Doccupine then:
24
+
22
25
  - Commits all pending changes to your GitHub repository
23
26
  - Triggers a new deployment
24
27
  - Clears all pending changes from the staging area
@@ -28,9 +31,11 @@ Doccupine then:
28
31
  </Callout>
29
32
 
30
33
  ## Discarding changes
34
+
31
35
  If you want to undo your pending edits, click **Discard All Changes** in the publish modal. This removes all staged changes without committing anything.
32
36
 
33
37
  ## File status badges
38
+
34
39
  In the publish modal, each file shows a badge indicating what changed:
35
40
 
36
41
  - **mod** - the file was modified
@@ -38,4 +43,5 @@ In the publish modal, each file shows a badge indicating what changed:
38
43
  - **bin** - the file is a binary asset (image, font, etc.)
39
44
 
40
45
  ## Auto-deploy from GitHub
46
+
41
47
  If you're using a user-connected GitHub repository and push changes directly (outside of Doccupine), the webhook triggers an automatic redeploy. This means you can use Doccupine's editor and Git-based workflows interchangeably.`;
@@ -1 +1 @@
1
- export declare const platformSiteSettingsMdxTemplate = "---\ntitle: \"Site Settings\"\ndescription: \"Configure your documentation site's name, description, icon, and image.\"\ndate: \"2026-02-19\"\ncategory: \"Configuration\"\ncategoryOrder: 2\norder: 0\nsection: \"Platform\"\n---\n# Site Settings\nThe Site settings page lets you configure the core metadata for your documentation site. These values are stored in `config.json` at the root of your repository.\n\n## Fields\n\n### Name\nThe name of your documentation site. This appears in the site header and browser tab title.\n\n### Description\nA short description of your documentation. Used in meta tags for search engine optimization and social media previews.\n\n### Favicon\nUpload a favicon image that appears in browser tabs. Supported formats include PNG, ICO, and SVG. Use the file upload button to select an image from your computer.\n\n### Preview image\nUpload an image used for social media and OpenGraph previews. This is the image that appears when your documentation URL is shared on platforms like Twitter, Slack, or Discord.\n\n### Site URL\nThe public URL of your deployed documentation site, such as `https://docs.example.com`. This value is used as the base URL when generating `sitemap.xml` and `robots.txt`, so search engines can discover and index your pages correctly. You can override this at deploy time by setting the `NEXT_PUBLIC_SITE_URL` environment variable.\n\n<Callout type=\"note\">\n Changes to site settings are staged as pending changes, just like file edits. Click **Publish** to commit them to your repository and trigger a deploy.\n</Callout>\n\n## How it works\nBehind the scenes, the Site settings page reads and writes `config.json` in your repository. You can also edit this file directly in the file editor if you prefer. See the [Globals](/globals) page for the full configuration reference.\n\n```json\n{\n \"name\": \"My Documentation\",\n \"description\": \"Documentation for my project\",\n \"icon\": \"/favicon.png\",\n \"image\": \"/preview.png\",\n \"url\": \"https://docs.example.com\"\n}\n```";
1
+ export declare const platformSiteSettingsMdxTemplate = "---\ntitle: \"Site Settings\"\ndescription: \"Configure your documentation site's name, description, icon, and image.\"\ndate: \"2026-02-19\"\ncategory: \"Configuration\"\ncategoryOrder: 2\norder: 0\nsection: \"Platform\"\n---\n\n# Site Settings\n\nThe Site settings page lets you configure the core metadata for your documentation site. These values are stored in `config.json` at the root of your repository.\n\n## Fields\n\n### Name\n\nThe name of your documentation site. This appears in the site header and browser tab title.\n\n### Description\n\nA short description of your documentation. Used in meta tags for search engine optimization and social media previews.\n\n### Favicon\n\nUpload a favicon image that appears in browser tabs. Supported formats include PNG, ICO, and SVG. Use the file upload button to select an image from your computer.\n\n### Preview image\n\nUpload an image used for social media and OpenGraph previews. This is the image that appears when your documentation URL is shared on platforms like Twitter, Slack, or Discord.\n\n### Site URL\n\nThe public URL of your deployed documentation site, such as `https://docs.example.com`. This value is used as the base URL when generating `sitemap.xml` and `robots.txt`, so search engines can discover and index your pages correctly. You can override this at deploy time by setting the `NEXT_PUBLIC_SITE_URL` environment variable.\n\n<Callout type=\"note\">\n Changes to site settings are staged as pending changes, just like file edits. Click **Publish** to commit them to your repository and trigger a deploy.\n</Callout>\n\n## How it works\n\nBehind the scenes, the Site settings page reads and writes `config.json` in your repository. You can also edit this file directly in the file editor if you prefer. See the [Globals](/globals) page for the full configuration reference.\n\n```json\n{\n \"name\": \"My Documentation\",\n \"description\": \"Documentation for my project\",\n \"icon\": \"/favicon.png\",\n \"image\": \"/preview.png\",\n \"url\": \"https://docs.example.com\"\n}\n```";
@@ -7,24 +7,31 @@ categoryOrder: 2
7
7
  order: 0
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Site Settings
12
+
11
13
  The Site settings page lets you configure the core metadata for your documentation site. These values are stored in \`config.json\` at the root of your repository.
12
14
 
13
15
  ## Fields
14
16
 
15
17
  ### Name
18
+
16
19
  The name of your documentation site. This appears in the site header and browser tab title.
17
20
 
18
21
  ### Description
22
+
19
23
  A short description of your documentation. Used in meta tags for search engine optimization and social media previews.
20
24
 
21
25
  ### Favicon
26
+
22
27
  Upload a favicon image that appears in browser tabs. Supported formats include PNG, ICO, and SVG. Use the file upload button to select an image from your computer.
23
28
 
24
29
  ### Preview image
30
+
25
31
  Upload an image used for social media and OpenGraph previews. This is the image that appears when your documentation URL is shared on platforms like Twitter, Slack, or Discord.
26
32
 
27
33
  ### Site URL
34
+
28
35
  The public URL of your deployed documentation site, such as \`https://docs.example.com\`. This value is used as the base URL when generating \`sitemap.xml\` and \`robots.txt\`, so search engines can discover and index your pages correctly. You can override this at deploy time by setting the \`NEXT_PUBLIC_SITE_URL\` environment variable.
29
36
 
30
37
  <Callout type="note">
@@ -32,6 +39,7 @@ The public URL of your deployed documentation site, such as \`https://docs.examp
32
39
  </Callout>
33
40
 
34
41
  ## How it works
42
+
35
43
  Behind the scenes, the Site settings page reads and writes \`config.json\` in your repository. You can also edit this file directly in the file editor if you prefer. See the [Globals](/globals) page for the full configuration reference.
36
44
 
37
45
  \`\`\`json
@@ -1 +1 @@
1
- export declare const platformTeamMembersMdxTemplate = "---\ntitle: \"Team Members\"\ndescription: \"Invite collaborators and manage roles for your documentation project.\"\ndate: \"2026-02-19\"\ncategory: \"Account\"\ncategoryOrder: 4\norder: 0\nsection: \"Platform\"\n---\n# Team Members\nThe Members settings page lets project owners invite collaborators and manage their access levels. Team members can view, edit, or manage billing depending on their assigned role.\n\n## Inviting members\n1. Navigate to your project's **Members** settings.\n2. Enter the collaborator's email address.\n3. Select a role.\n4. Click **Add Member**.\n\nThe invited user will see the project under **Shared Projects** on their dashboard.\n\n## Roles\n\n### Viewer\nCan browse files and view the project, but cannot make edits or publish changes. Useful for stakeholders who need read access.\n\n### Editor\nCan edit files and publish changes. Can also modify site configuration (theme, navigation, fonts, etc.). Cannot manage team members or billing.\n\n### Billing\nCan access the billing management page and Stripe billing portal. Cannot edit files or site configuration.\n\n<Callout type=\"note\">\n The project **owner** has full access to everything - editing, publishing, configuration, member management, billing, and project deletion.\n</Callout>\n\n## Member limits\nThe number of team members depends on your plan:\n\n- **Pro** - up to 5 members\n- **Enterprise** - unlimited members\n\nThe Members page shows your current count against your plan's limit.\n\n## Removing members\nProject owners can remove any member by clicking the remove button next to their name. Members can also remove themselves from a project by clicking **Leave Project**.";
1
+ export declare const platformTeamMembersMdxTemplate = "---\ntitle: \"Team Members\"\ndescription: \"Invite collaborators and manage roles for your documentation project.\"\ndate: \"2026-02-19\"\ncategory: \"Account\"\ncategoryOrder: 4\norder: 0\nsection: \"Platform\"\n---\n\n# Team Members\n\nThe Members settings page lets project owners invite collaborators and manage their access levels. Team members can view, edit, or manage billing depending on their assigned role.\n\n## Inviting members\n\n1. Navigate to your project's **Members** settings.\n2. Enter the collaborator's email address.\n3. Select a role.\n4. Click **Add Member**.\n\nThe invited user will see the project under **Shared Projects** on their dashboard.\n\n## Roles\n\n### Viewer\n\nCan browse files and view the project, but cannot make edits or publish changes. Useful for stakeholders who need read access.\n\n### Editor\n\nCan edit files and publish changes. Can also modify site configuration (theme, navigation, fonts, etc.). Cannot manage team members or billing.\n\n### Billing\n\nCan access the billing management page and Stripe billing portal. Cannot edit files or site configuration.\n\n<Callout type=\"note\">\n The project **owner** has full access to everything - editing, publishing, configuration, member management, billing, and project deletion.\n</Callout>\n\n## Member limits\n\nThe number of team members depends on your plan:\n\n- **Pro** - up to 5 members\n- **Enterprise** - unlimited members\n\nThe Members page shows your current count against your plan's limit.\n\n## Removing members\n\nProject owners can remove any member by clicking the remove button next to their name. Members can also remove themselves from a project by clicking **Leave Project**.";
@@ -7,10 +7,13 @@ categoryOrder: 4
7
7
  order: 0
8
8
  section: "Platform"
9
9
  ---
10
+
10
11
  # Team Members
12
+
11
13
  The Members settings page lets project owners invite collaborators and manage their access levels. Team members can view, edit, or manage billing depending on their assigned role.
12
14
 
13
15
  ## Inviting members
16
+
14
17
  1. Navigate to your project's **Members** settings.
15
18
  2. Enter the collaborator's email address.
16
19
  3. Select a role.
@@ -21,12 +24,15 @@ The invited user will see the project under **Shared Projects** on their dashboa
21
24
  ## Roles
22
25
 
23
26
  ### Viewer
27
+
24
28
  Can browse files and view the project, but cannot make edits or publish changes. Useful for stakeholders who need read access.
25
29
 
26
30
  ### Editor
31
+
27
32
  Can edit files and publish changes. Can also modify site configuration (theme, navigation, fonts, etc.). Cannot manage team members or billing.
28
33
 
29
34
  ### Billing
35
+
30
36
  Can access the billing management page and Stripe billing portal. Cannot edit files or site configuration.
31
37
 
32
38
  <Callout type="note">
@@ -34,6 +40,7 @@ Can access the billing management page and Stripe billing portal. Cannot edit fi
34
40
  </Callout>
35
41
 
36
42
  ## Member limits
43
+
37
44
  The number of team members depends on your plan:
38
45
 
39
46
  - **Pro** - up to 5 members
@@ -42,4 +49,5 @@ The number of team members depends on your plan:
42
49
  The Members page shows your current count against your plan's limit.
43
50
 
44
51
  ## Removing members
52
+
45
53
  Project owners can remove any member by clicking the remove button next to their name. Members can also remove themselves from a project by clicking **Leave Project**.`;