doccupine 0.0.38 → 0.0.39
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.
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const deploymentMdxTemplate = "---\ntitle: \"Deployment\"\ndescription: \"Deploy your Doccupine
|
|
1
|
+
export declare const deploymentMdxTemplate = "---\ntitle: \"Deployment\"\ndescription: \"Deploy your documentation site with Doccupine or self-host on Vercel.\"\ndate: \"2025-01-15\"\ncategory: \"Configuration\"\ncategoryOrder: 3\norder: 9\n---\n# Deployment\n\n## Deploy with Doccupine\n\nSign up for an account at [Doccupine](https://www.doccupine.com) and create your docs instantly \u2014 no build configuration, no infrastructure to manage.\n\nDoccupine gives you:\n- **Automatic deployments** on every push to your repository\n- **Site customization** through a visual dashboard \u2014 no code changes needed\n- **Team collaboration** so your whole team can manage docs together\n- **Custom domains** with automatic SSL\n- **AI Assistant and MCP server** included out of the box, no API key required\n\nGet started at [doccupine.com](https://www.doccupine.com).\n\n---\n\n## Self-hosting on Vercel\n\nIf you prefer to self-host, Doccupine generates a standard Next.js app that can be deployed to Vercel.\n\n<Callout type=\"warning\">\n Deploy the generated website directory (the Next.js app), not your MDX source folder. In a monorepo, set the Vercel <strong>Root Directory</strong> to the generated site folder.\n</Callout>\n\n### Quick start\n1. Push the generated site folder to GitHub, GitLab, or Bitbucket.\n2. Import the repository at [vercel.com/new](https://vercel.com/new). Vercel auto-detects Next.js and applies the correct build settings.\n3. Add any required environment variables under Project \u2192 Settings \u2192 Environment Variables.\n4. Deploy. Vercel creates Preview deployments per branch and promotes to Production on merge to main.\n\nYou can also deploy from the command line with the [Vercel CLI](https://vercel.com/docs/cli):\n\n```bash\nnpm i -g vercel\n```\n\n### Custom domains\nAdd a domain under Project \u2192 Settings \u2192 Domains and point your DNS to Vercel.\n\n### Troubleshooting\n- **Build failed** \u2014 Check build logs. Ensure your lockfile and correct Node.js version are present.\n- **Missing content** \u2014 Verify your MDX files and assets are in the repository.";
|
|
@@ -1,76 +1,51 @@
|
|
|
1
1
|
export const deploymentMdxTemplate = `---
|
|
2
2
|
title: "Deployment"
|
|
3
|
-
description: "Deploy your Doccupine
|
|
3
|
+
description: "Deploy your documentation site with Doccupine or self-host on Vercel."
|
|
4
4
|
date: "2025-01-15"
|
|
5
5
|
category: "Configuration"
|
|
6
6
|
categoryOrder: 3
|
|
7
7
|
order: 9
|
|
8
8
|
---
|
|
9
9
|
# Deployment
|
|
10
|
-
Deploy your Doccupine site as a Next.js application on Vercel. You can connect a Git repository for automatic deployments or use the Vercel CLI for manual control.
|
|
11
10
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
## Deploy with Doccupine
|
|
12
|
+
|
|
13
|
+
Sign up for an account at [Doccupine](https://www.doccupine.com) and create your docs instantly — no build configuration, no infrastructure to manage.
|
|
14
|
+
|
|
15
|
+
Doccupine gives you:
|
|
16
|
+
- **Automatic deployments** on every push to your repository
|
|
17
|
+
- **Site customization** through a visual dashboard — no code changes needed
|
|
18
|
+
- **Team collaboration** so your whole team can manage docs together
|
|
19
|
+
- **Custom domains** with automatic SSL
|
|
20
|
+
- **AI Assistant and MCP server** included out of the box, no API key required
|
|
15
21
|
|
|
16
|
-
|
|
17
|
-
- **Vercel account**: https://vercel.com/signup
|
|
18
|
-
- **Git repository**: GitHub, GitLab, or Bitbucket with your Next.js app
|
|
19
|
-
- **Node.js**: Use an LTS version
|
|
22
|
+
Get started at [doccupine.com](https://www.doccupine.com).
|
|
20
23
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
3. If your repo is a monorepo, set the project **Root Directory** to the generated website folder (Project → Settings → General → Root Directory).
|
|
25
|
-
4. **Framework preset**: Vercel auto-detects Next.js.
|
|
26
|
-
5. **Build settings** (defaults are fine):
|
|
27
|
-
- Install Command: \`pnpm i\`, \`yarn\`, or \`npm i\` (Vercel auto-detects)
|
|
28
|
-
- Build Command: \`next build\`
|
|
29
|
-
- Output: handled automatically by Vercel for Next.js
|
|
30
|
-
6. **Environment Variables**: Add any values required by your docs (see below).
|
|
31
|
-
7. **Deploy**: Vercel creates a Preview deployment per branch. Merge to your main branch to promote to Production.
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Self-hosting on Vercel
|
|
32
27
|
|
|
33
|
-
|
|
34
|
-
1. Install the CLI:
|
|
35
|
-
\`\`\`bash
|
|
36
|
-
npm i -g vercel
|
|
37
|
-
\`\`\`
|
|
38
|
-
2. From the generated website directory, run:
|
|
39
|
-
\`\`\`bash
|
|
40
|
-
vercel
|
|
41
|
-
\`\`\`
|
|
42
|
-
Follow the prompts to link or create a project.
|
|
43
|
-
3. When ready for production:
|
|
44
|
-
\`\`\`bash
|
|
45
|
-
vercel --prod
|
|
46
|
-
\`\`\`
|
|
28
|
+
If you prefer to self-host, Doccupine generates a standard Next.js app that can be deployed to Vercel.
|
|
47
29
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
- Or via CLI:
|
|
52
|
-
\`\`\`bash
|
|
53
|
-
vercel env add NAME
|
|
54
|
-
\`\`\`
|
|
30
|
+
<Callout type="warning">
|
|
31
|
+
Deploy the generated website directory (the Next.js app), not your MDX source folder. In a monorepo, set the Vercel <strong>Root Directory</strong> to the generated site folder.
|
|
32
|
+
</Callout>
|
|
55
33
|
|
|
56
|
-
|
|
34
|
+
### Quick start
|
|
35
|
+
1. Push the generated site folder to GitHub, GitLab, or Bitbucket.
|
|
36
|
+
2. Import the repository at [vercel.com/new](https://vercel.com/new). Vercel auto-detects Next.js and applies the correct build settings.
|
|
37
|
+
3. Add any required environment variables under Project → Settings → Environment Variables.
|
|
38
|
+
4. Deploy. Vercel creates Preview deployments per branch and promotes to Production on merge to main.
|
|
57
39
|
|
|
58
|
-
|
|
59
|
-
- Ensure a valid \`next.config.js\` if you customize images, basePath, or MDX handling.
|
|
60
|
-
- If you use MDX, include the necessary plugins/config in your project.
|
|
61
|
-
- Vercel automatically enables Image Optimization and Edge/CDN features for Next.js.
|
|
40
|
+
You can also deploy from the command line with the [Vercel CLI](https://vercel.com/docs/cli):
|
|
62
41
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
42
|
+
\`\`\`bash
|
|
43
|
+
npm i -g vercel
|
|
44
|
+
\`\`\`
|
|
66
45
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
- **Missing content**: Ensure your MDX directory and any assets are included in the repository.
|
|
70
|
-
- **Env not applied**: Add variables for the correct environment (Preview vs Production) and redeploy.
|
|
71
|
-
- **Images not loading**: Configure \`images.domains\` in \`next.config.js\` if using remote images.
|
|
46
|
+
### Custom domains
|
|
47
|
+
Add a domain under Project → Settings → Domains and point your DNS to Vercel.
|
|
72
48
|
|
|
73
|
-
|
|
74
|
-
- **
|
|
75
|
-
- **
|
|
76
|
-
- **Consistent tooling**: Keep a single package manager and lockfile in the repo (npm, pnpm, or yarn).`;
|
|
49
|
+
### Troubleshooting
|
|
50
|
+
- **Build failed** — Check build logs. Ensure your lockfile and correct Node.js version are present.
|
|
51
|
+
- **Missing content** — Verify your MDX files and assets are in the repository.`;
|
package/package.json
CHANGED