doccupine 0.0.50 → 0.0.52

package/LICENSE

@@ -2,7 +2,7 @@ Copyright © 2026, Doccupine.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-No licensee or downstream recipient may use the Software (including any modified or derivative versions) to directly compete with the original Licensor by offering it to third parties as a hosted, managed, or Software-as-a-Service (SaaS) product or cloud service where the primary value of the service is the functionality of the Software itself.
+1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+2. No licensee or downstream recipient may use the Software (including any modified or derivative versions) to directly compete with the original Licensor by offering it to third parties as a hosted, managed, or Software-as-a-Service (SaaS) product or cloud service where the primary value of the service is the functionality of the Software itself.
 
 THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,39 +1,105 @@
-# Welcome to Doccupine
+# Doccupine
 
-[Doccupine](https://doccupine.com) is a free and open-source document management system that allows you to store, organize, and share your documentation with ease. Using Doccupine, you simply create your documentation in MDX files with traditional Markdown syntax, Doccupine monitors your changes automatically generating a beautiful, modern documentation website.
+[![npm version](https://img.shields.io/npm/v/doccupine.svg)](https://www.npmjs.com/package/doccupine)
 
-## Open Source and Extensible
-
-Doccupine is built on open standards, enabling customization and extensibility for different documentation needs. You stay in control of your content, with the option to host docs yourself and tailor the website’s look and features to match your organization’s requirements.
+[Doccupine](https://doccupine.com) is an open-source CLI that turns a directory of MDX files into a full-featured Next.js documentation website. Write your docs in Markdown, and Doccupine watches for changes, generates pages, and starts a live dev server automatically.
 
 ## Features
 
-- 📝 Markdown-based content
-- 📦 Built-in file structure
-- ⚡ Live Preview & Auto-Update
-- 🚀 Easy Deployment
-- 🤖 AI-powered
-- 🔌 Model Context Protocol (MCP)
+- **Live preview** - watches your MDX files and regenerates pages on every save
+- **Auto-generated navigation** - sidebar built from frontmatter (`category`, `order`)
+- **Theming** - dark/light mode with customizable theme via `theme.json`
+- **AI chat assistant** - built-in RAG-powered chat (OpenAI, Anthropic, or Google)
+- **MCP server** - exposes `search_docs`, `get_doc`, and `list_docs` tools for AI agents
+- **Custom fonts** - Google Fonts or local fonts via `fonts.json`
+- **Zero config to start** - `npx doccupine` scaffolds everything and starts the server
+
+## Quick Start
+
+Make sure you have [Node.js](https://nodejs.org) (v18+) installed.
+
+```bash
+npx doccupine
+```
 
-## Getting Started
+Doccupine will prompt you for:
 
-To get started with Doccupine, make sure you have [Node.js](https://nodejs.org) and npm installed on your machine. Then, follow these steps:
+1. A directory to store your MDX files (default: `docs`)
+2. An output directory for the generated Next.js app (default: `nextjs-app`)
 
-- **Run Doccupine CLI:**
+It then scaffolds the app, installs dependencies, and starts the dev server. Open http://localhost:3000 to view your docs.
 
-Create a new directory for your project and navigate to it in your terminal. Run the following command to create a new Doccupine project:
+## CLI Commands
 
 ```bash
-npx doccupine
+doccupine watch [options]   # Default. Watch MDX files and start dev server
+doccupine build [options]   # One-time build without starting the server
+doccupine config --show     # Show current configuration
+doccupine config --reset    # Re-prompt for configuration
+```
+
+### Options
+
+| Flag            | Description                                                          |
+| --------------- | -------------------------------------------------------------------- |
+| `--port <port>` | Port for the dev server (default: `3000`). Auto-increments if taken. |
+| `--verbose`     | Show all Next.js output including compilation details                |
+| `--reset`       | Re-prompt for watch/output directories                               |
+
+## MDX Frontmatter
+
+Each MDX file supports these frontmatter fields:
+
+```yaml
+---
+title: "Page Title"
+description: "Page description for SEO"
+category: "Getting Started"
+categoryOrder: 0 # Sort order for the category group
+order: 1 # Sort order within the category
+icon: "https://..." # Page favicon URL
+image: "https://..." # OpenGraph image URL
+---
+```
+
+Navigation is auto-generated from `category`, `categoryOrder`, and `order`. Pages without a category appear ungrouped.
+
+## Configuration Files
+
+Place these JSON files in your project root (where you run `doccupine`). They are auto-copied to the generated app and watched for changes.
+
+| File              | Purpose                                                                                                   |
+| ----------------- | --------------------------------------------------------------------------------------------------------- |
+| `doccupine.json`  | CLI config (watchDir, outputDir, port). Auto-generated on first run.                                      |
+| `config.json`     | Site metadata: `name`, `description`, `icon`, `preview` image URL                                         |
+| `theme.json`      | Theme overrides for [cherry-styled-components](https://github.com/cherry-design-system/styled-components) |
+| `navigation.json` | Manual navigation structure (overrides auto-generated)                                                    |
+| `links.json`      | Static header/footer links                                                                                |
+| `fonts.json`      | Font configuration (Google Fonts or local)                                                                |
+
+## AI Chat Setup
+
+The generated app includes an AI chat assistant. To enable it, create a `.env.local` file in the generated app directory:
+
+```env
+LLM_PROVIDER=openai # openai | anthropic | google
+OPENAI_API_KEY=sk-...
+# Or: ANTHROPIC_API_KEY=sk-ant-...
+# Or: GOOGLE_API_KEY=...
 ```
 
-Once you run the command, Doccupine will ask you to select a directory to store your MDX files. Choose the directory where you want to create your documentation files.
-After selecting the directory, Doccupine will ask you to enter the name of the directory for the generated website. Enter the name of the directory where you want to create your website.
+If `LLM_PROVIDER` is not set, the chat component is hidden automatically.
+
+## MCP Server
+
+The generated app exposes an MCP endpoint at `/api/mcp` with three tools:
 
-This will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.
+- `search_docs` - semantic search across all documentation
+- `get_doc` - retrieve a specific document by path
+- `list_docs` - list all available documents
 
-## Start documenting
+This lets AI agents (Claude, ChatGPT, etc.) query your docs programmatically. Requires the AI chat setup above for embeddings.
 
-Start documenting your project by editing the `index.mdx` file in the choosen MDX directory, this is the content for the home page of your documentation website.
+## License
 
-In your MDX directory, you can structure your content using folders and files. Doccupine will automatically generate a navigation menu based on the configured categories and order.
+This project is licensed under a modified MIT license with a SaaS restriction. See [LICENSE](LICENSE) for details.

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 #!/usr/bin/env node
-export {};
+export declare function generateSlug(filePath: string): string;
+export declare function escapeTemplateContent(content: string): string;