doccupine 0.0.90 → 0.0.91

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 (4) hide show
  1. package/README.md +29 -0
  2. package/dist/templates/mdx/update.mdx.d.ts +1 -1
  3. package/dist/templates/mdx/update.mdx.js +4 -2
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -42,12 +42,27 @@ doccupine config --reset # Re-prompt for configuration
42
42
 
43
43
  ### Options
44
44
 
45
+ `watch` (default):
46
+
45
47
  | Flag | Description |
46
48
  | --------------- | -------------------------------------------------------------------- |
47
49
  | `--port <port>` | Port for the dev server (default: `3000`). Auto-increments if taken. |
48
50
  | `--verbose` | Show all Next.js output including compilation details |
49
51
  | `--reset` | Re-prompt for watch/output directories |
50
52
 
53
+ `build`:
54
+
55
+ | Flag | Description |
56
+ | --------- | -------------------------------------- |
57
+ | `--reset` | Re-prompt for watch/output directories |
58
+
59
+ `config`:
60
+
61
+ | Flag | Description |
62
+ | --------- | ---------------------------------------- |
63
+ | `--show` | Print the current configuration and exit |
64
+ | `--reset` | Re-prompt for watch/output directories |
65
+
51
66
  ## MDX Frontmatter
52
67
 
53
68
  Each MDX file supports these frontmatter fields:
@@ -154,6 +169,20 @@ Doccupine generates `robots.ts` automatically for every site. When you set a `ur
154
169
 
155
170
  You can override the URL at deploy time by setting the `NEXT_PUBLIC_SITE_URL` environment variable. When no URL is configured (neither in `config.json` nor via env), the sitemap is skipped and `robots.txt` is emitted without a sitemap reference.
156
171
 
172
+ ## llms.txt
173
+
174
+ Doccupine generates [llms.txt](https://llmstxt.org) artifacts so AI agents can discover and ingest your docs. On every regeneration, the following files are written to the generated app's `public/` directory:
175
+
176
+ | File | Contents |
177
+ | --------------------- | ---------------------------------------------------------------------------------------------- |
178
+ | `llms.txt` | Index of every page (title, description, URL), grouped by section and category |
179
+ | `llms-full.txt` | Full-text bundle: every page's body concatenated for one-shot ingestion |
180
+ | `public/<slug>.md` | Per-page Markdown mirror of each MDX page, suitable for direct fetching at `/<slug>.md` |
181
+
182
+ The site name and description used in `llms.txt` come from `config.json` (`name`, `description`). Page URLs are absolute when `url` is set in `config.json` (or via `NEXT_PUBLIC_SITE_URL`), and root-relative otherwise.
183
+
184
+ A `.doccupine-llms-manifest.json` file in the generated app tracks which per-page mirrors were emitted so renamed or deleted pages get cleaned up on the next regeneration. Don't commit this file — it's regenerated automatically.
185
+
157
186
  ## AI Chat Setup
158
187
 
159
188
  The generated app includes an AI chat assistant. To enable it, create a `.env` file in the generated app directory:
package/dist/templates/mdx/update.mdx.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const updateMdxTemplate = "---\ntitle: \"Update\"\ndescription: \"Easily manage and present change history.\"\ndate: \"2026-02-19\"\ncategory: \"Components\"\ncategoryOrder: 1\norder: 12\n---\n\n# Update\n\nEasily manage and present change history.\n\nThe `Update` component helps you display release notes, version details, and changelogs in a standardized format.\n\n<Update label=\"Example\" description=\"v0.0.1\">\n ## Example entry\n\nYou can include anything here\u2014images, code snippets, or a bullet list of modifications.\n\n![Demo Image](https://docs.doccupine.com/demo.png)\n\n### Key additions\n\n- Fully responsive layout\n- Individual anchor for each update\n- Automatic RSS feed entry generation\n </Update>\n\n## Update Usage\n\nYou can combine multiple `Update` components to build complete changelogs.\n\n```mdx\n<Update label=\"Example\" description=\"v0.0.1\">\n ## Example entry\n\nYou can include anything here\u2014images, code snippets, or a bullet list of modifications.\n\n![Demo Image](https://docs.doccupine.com/demo.png)\n\n### Key additions\n\n- Fully responsive layout\n- Individual anchor for each update\n- Automatic RSS feed entry generation\n </Update>\n```\n\n## Properties\n\n<Field value=\"label\" type=\"string\" required>\n The label of the update.\n</Field>\n\n<Field value=\"description\" type=\"string\" required>\n The description of the update.\n</Field>\n\n<Field value=\"children\" type=\"node\" required>\n The content of the update.\n</Field>";
1
+ export declare const updateMdxTemplate = "---\ntitle: \"Update\"\ndescription: \"Easily manage and present change history.\"\ndate: \"2026-02-19\"\ncategory: \"Components\"\ncategoryOrder: 1\norder: 12\n---\n\n# Update\n\nEasily manage and present change history.\n\nThe `Update` component helps you display release notes, version details, and changelogs in a standardized format.\n\n<Update label=\"Example\" description=\"v0.0.1\">\n ## Example entry\n\nYou can include anything here\u2014images, code snippets, or a bullet list of modifications.\n\n![Demo Image](https://docs.doccupine.com/demo.png)\n\n### Key additions\n\n- Fully responsive layout\n- Individual anchor for each update\n- Automatic RSS feed entry generation\n\n</Update>\n\n## Update Usage\n\nYou can combine multiple `Update` components to build complete changelogs.\n\n```mdx\n<Update label=\"Example\" description=\"v0.0.1\">\n ## Example entry\n\nYou can include anything here\u2014images, code snippets, or a bullet list of modifications.\n\n![Demo Image](https://docs.doccupine.com/demo.png)\n\n### Key additions\n\n- Fully responsive layout\n- Individual anchor for each update\n- Automatic RSS feed entry generation\n\n</Update>\n```\n\n## Properties\n\n<Field value=\"label\" type=\"string\" required>\n The label of the update.\n</Field>\n\n<Field value=\"description\" type=\"string\" required>\n The description of the update.\n</Field>\n\n<Field value=\"children\" type=\"node\" required>\n The content of the update.\n</Field>";
package/dist/templates/mdx/update.mdx.js CHANGED
@@ -25,7 +25,8 @@ You can include anything here—images, code snippets, or a bullet list of modif
25
25
  - Fully responsive layout
26
26
  - Individual anchor for each update
27
27
  - Automatic RSS feed entry generation
28
- </Update>
28
+
29
+ </Update>
29
30
 
30
31
  ## Update Usage
31
32
 
@@ -44,7 +45,8 @@ You can include anything here—images, code snippets, or a bullet list of modif
44
45
  - Fully responsive layout
45
46
  - Individual anchor for each update
46
47
  - Automatic RSS feed entry generation
47
- </Update>
48
+
49
+ </Update>
48
50
  \`\`\`
49
51
 
50
52
  ## Properties
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "doccupine",
3
- "version": "0.0.90",
3
+ "version": "0.0.91",
4
4
  "description": "Free and open-source documentation platform. Write MDX, get a production-ready site with AI chat, built-in components, and an MCP server - in one command.",
5
5
  "main": "dist/index.js",
6
6
  "bin": {