doccupine 0.0.2 → 0.0.4

package/README.md

@@ -6,6 +6,13 @@ Doccupine is a free and open-source document management system that allows you t
 
 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.
 
+## Features
+
+- 📝 Markdown-based content
+- 📦 Built-in file structure
+- ⚡ Live Preview & Auto-Update
+- 🚀 Easy Deployment
+
 ## Getting Started
 
 To get started with Doccupine, make sure you have [Node.js](https://nodejs.org) and npm installed on your machine. Then, follow these steps:
@@ -23,38 +30,8 @@ After selecting the directory, Doccupine will ask you to enter the name of the d
 
 This will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.
 
-- **Generate the website:**
-
-```bash
-npx doccupine build
-```
-
-This will generate the build files for your documentation website without starting the development server. You can then deploy the generated files to a hosting service of your choice.
-
-## Features
-
-- 📝 Markdown-based content
-- 📦 Built-in file structure
-- ⚡ Live Preview & Auto-Update
-- 🚀 Easy Deployment
-
 ## Start documenting
 
-Start documenting your project by creating a new **index.mdx** file in the choosen MDX directory. You can use the following template as a starting point:
-
-```text
----
-title: "Home"
-description: "This is my first Doccupine project"
-date: "2025-01-15"
-category: "General"
-categoryOrder: 0
-order: 0
----
-
-# Home
-
-This is some **markdown** content with MDX support.
-```
+Start documenting your project by editing the **index.mdx** file in the choosen MDX directory.
 
 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.

package/dist/index.js

@@ -7,7 +7,9 @@ import matter from "gray-matter";
 import chalk from "chalk";
 import prompts from "prompts";
 import { gitignoreTemplate } from "./templates/gitignore.js";
-import { homeTemplate } from "./templates/home.js";
+import { packageJsonTemplate } from "./templates/package.js";
+import { nextConfigTemplate } from "./templates/next.config.js";
+import { tsconfigTemplate } from "./templates/tsconfig.js";
 import { notFoundTemplate } from "./templates/not-found.js";
 import { layoutTemplate } from "./templates/layout.js";
 import { themeTemplate } from "./templates/theme.js";
@@ -24,6 +26,75 @@ import { clickOutsideTemplate } from "./templates/components/ClickOutside.js";
 import { docsTemplate } from "./templates/components/Docs.js";
 import { orderNavItemsTemplate } from "./templates/utils/orderNavItems.js";
 import { sideBarTemplate } from "./templates/components/SideBar.js";
+import { homeMdxTemplate } from "./templates/home.mdx.js";
+import { commandsMdxTemplate } from "./templates/commands.mdx.js";
+class ConfigManager {
+    configPath;
+    constructor(configPath = "doccupine.json") {
+        this.configPath = path.resolve(process.cwd(), configPath);
+    }
+    async loadConfig() {
+        try {
+            if (await fs.pathExists(this.configPath)) {
+                const configContent = await fs.readFile(this.configPath, "utf8");
+                const config = JSON.parse(configContent);
+                console.log(chalk.blue("📄 Using existing configuration from doccupine.json"));
+                return config;
+            }
+        }
+        catch (error) {
+            console.warn(chalk.yellow("⚠️ Error reading config file, will create new one"));
+        }
+        return null;
+    }
+    async saveConfig(config) {
+        try {
+            await fs.writeFile(this.configPath, JSON.stringify(config, null, 2), "utf8");
+            console.log(chalk.green("💾 Configuration saved to doccupine.json"));
+        }
+        catch (error) {
+            console.error(chalk.red("❌ Error saving config file:"), error);
+        }
+    }
+    async promptForConfig(existingConfig) {
+        const questions = [
+            {
+                type: "text",
+                name: "watchDir",
+                message: "Enter directory to watch for MDX files:",
+                initial: existingConfig?.watchDir || "docs",
+            },
+            {
+                type: "text",
+                name: "outputDir",
+                message: "Enter output directory for Next.js app:",
+                initial: existingConfig?.outputDir || "nextjs-app",
+            },
+        ];
+        const { watchDir, outputDir } = (await prompts(questions));
+        return {
+            watchDir: path.resolve(process.cwd(), watchDir),
+            outputDir: path.resolve(process.cwd(), outputDir),
+            port: existingConfig?.port || "3000",
+        };
+    }
+    async getConfig(options = {}) {
+        let config = null;
+        if (!options.reset) {
+            config = await this.loadConfig();
+        }
+        if (!config || options.reset) {
+            console.log(chalk.blue("🔧 Setting up Doccupine configuration..."));
+            config = await this.promptForConfig(config || {});
+            await this.saveConfig(config);
+        }
+        if (options.port) {
+            config.port = options.port;
+            await this.saveConfig(config);
+        }
+        return config;
+    }
+}
 class MDXToNextJSGenerator {
     watchDir;
     outputDir;
@@ -34,12 +105,10 @@ class MDXToNextJSGenerator {
     }
     async init() {
         console.log(chalk.blue("🚀 Initializing MDX to Next.js generator..."));
-        // Ensure directories exist
         await fs.ensureDir(this.watchDir);
         await fs.ensureDir(this.outputDir);
-        // Create initial Next.js structure
         await this.createNextJSStructure();
-        // Process existing files
+        await this.createStartingDocs();
         await this.processAllMDXFiles();
         console.log(chalk.green("✅ Initial setup complete!"));
         console.log(chalk.cyan("💡 To start the Next.js dev server:"));
@@ -53,7 +122,6 @@ class MDXToNextJSGenerator {
             "next.config.ts": this.generateNextConfig(),
             "tsconfig.json": this.generateTSConfig(),
             "app/layout.tsx": await this.generateRootLayout(),
-            "app/page.tsx": this.generateHomePage(),
             "app/not-found.tsx": this.generateNotFoundPage(),
             "app/theme.ts": this.generateTheme(),
             "components/layout/Icon.tsx": this.generateIcon(),
@@ -76,17 +144,52 @@ class MDXToNextJSGenerator {
             await fs.writeFile(fullPath, String(content), "utf8");
         }
     }
+    async createStartingDocs() {
+        const structure = {
+            "index.mdx": this.generateHomeMdx(),
+            "commands.mdx": this.generateCommandsMdx(),
+        };
+        const indexMdxExists = await fs.pathExists(path.join(this.watchDir, "index.mdx"));
+        if (!indexMdxExists) {
+            for (const [filePath, content] of Object.entries(structure)) {
+                const fullPath = path.join(this.watchDir, filePath);
+                await fs.ensureDir(path.dirname(fullPath));
+                await fs.writeFile(fullPath, String(content), "utf8");
+            }
+        }
+    }
     async startWatching() {
         console.log(chalk.yellow(`👀 Watching for changes in: ${this.watchDir}`));
-        this.watcher = chokidar.watch("**/*.mdx", {
-            cwd: this.watchDir,
+        this.watcher = chokidar.watch(this.watchDir, {
             persistent: true,
-            ignoreInitial: false,
+            ignoreInitial: true,
+            ignored: (filePath, stats) => {
+                const isFile = stats?.isFile() ?? path.extname(filePath) !== "";
+                if (isFile && !filePath.endsWith(".mdx")) {
+                    return true;
+                }
+                return false;
+            },
         });
         this.watcher
-            .on("add", (filePath) => this.handleFileChange("added", filePath))
-            .on("change", (filePath) => this.handleFileChange("changed", filePath))
-            .on("unlink", (filePath) => this.handleFileDelete(filePath));
+            .on("add", (filePath) => {
+            const relativePath = path.relative(this.watchDir, filePath);
+            this.handleFileChange("added", relativePath);
+        })
+            .on("change", (filePath) => {
+            const relativePath = path.relative(this.watchDir, filePath);
+            this.handleFileChange("changed", relativePath);
+        })
+            .on("unlink", (filePath) => {
+            const relativePath = path.relative(this.watchDir, filePath);
+            this.handleFileDelete(relativePath);
+        })
+            .on("ready", () => {
+            console.log(chalk.green("📁 Initial scan complete. Ready for changes..."));
+        })
+            .on("error", (error) => {
+            console.error(chalk.red("❌ Watcher error:"), error);
+        });
     }
     async handleFileChange(action, filePath) {
         console.log(chalk.cyan(`📝 File ${action}: ${filePath}`));
@@ -197,6 +300,12 @@ const content = \`${mdxFile.content.replace(/`/g, "\\`")}\`;
 export const metadata: Metadata = {
   title: '${mdxFile.frontmatter.title || "Generated with Doccupine"}',
   description: '${mdxFile.frontmatter.description || "Automatically generated from MDX files using Doccupine"}',
+  icons: '${mdxFile.frontmatter.icon || ""}',
+  openGraph: {
+    title: '${mdxFile.frontmatter.title || "Generated with Doccupine"}',
+    description: '${mdxFile.frontmatter.description || "Automatically generated from MDX files using Doccupine"}',
+    images: '${mdxFile.frontmatter.image || ""}',
+  }
 };
 
 export default function Page() {
@@ -224,6 +333,8 @@ export default function Page() {
                     description: frontmatter.description || "",
                     categoryOrder: frontmatter.categoryOrder || 0,
                     order: frontmatter.order || 0,
+                    icon: frontmatter.icon || "",
+                    image: frontmatter.image || "",
                 };
             }
         }
@@ -236,6 +347,12 @@ ${indexMDX
             ? `export const metadata: Metadata = {
   title: '${indexMDX.title}',
   description: '${indexMDX.description}',
+  icons: '${indexMDX.icon}',
+    openGraph: {
+      title: '${indexMDX.title}',
+      description: '${indexMDX.description}',
+      images: '${indexMDX.image}',
+    }
 };`
             : `export const metadata: Metadata = {
   title: 'Generated with Doccupine',
@@ -252,86 +369,14 @@ export default function Home() {
     generateGitIgnore() {
         return gitignoreTemplate;
     }
-    // Configuration file generators
     generatePackageJson() {
-        return JSON.stringify({
-            name: "doccupine",
-            version: "0.1.0",
-            private: true,
-            scripts: {
-                dev: "next dev",
-                build: "next build",
-                start: "next start",
-                lint: "next lint",
-            },
-            dependencies: {
-                next: "15.5.2",
-                react: "19.1.1",
-                "react-dom": "19.1.1",
-            },
-            devDependencies: {
-                "@types/node": "^24",
-                "@types/react": "^19",
-                "@types/react-dom": "^19",
-                "cherry-styled-components": "^0.1.0-43",
-                eslint: "^9",
-                "eslint-config-next": "15.5.2",
-                "lucide-react": "^0.542.0",
-                polished: "^4.3.1",
-                prettier: "^3.6.2",
-                "react-markdown": "^10.1.0",
-                "rehype-highlight": "^7.0.2",
-                "rehype-parse": "^9.0.1",
-                "rehype-stringify": "^10.0.1",
-                "remark-gfm": "^4.0.1",
-                "styled-components": "^6.1.19",
-                typescript: "^5",
-            },
-        }, null, 2);
+        return packageJsonTemplate;
     }
     generateNextConfig() {
-        return `import type { NextConfig } from "next";
-
-const nextConfig: NextConfig = {
-  compiler: {
-    styledComponents: true,
-  },
-  transpilePackages: ["lucide-react"],
-};
-
-export default nextConfig;
-`;
+        return nextConfigTemplate;
     }
     generateTSConfig() {
-        return JSON.stringify({
-            compilerOptions: {
-                target: "es5",
-                lib: ["dom", "dom.iterable", "es6"],
-                allowJs: true,
-                skipLibCheck: true,
-                strict: true,
-                noEmit: true,
-                esModuleInterop: true,
-                module: "esnext",
-                moduleResolution: "bundler",
-                resolveJsonModule: true,
-                isolatedModules: true,
-                jsx: "preserve",
-                incremental: true,
-                plugins: [{ name: "next" }],
-                baseUrl: ".",
-                paths: {
-                    "@/*": ["./*"],
-                },
-            },
-            include: [
-                "next-env.d.ts",
-                "**/*.ts",
-                "**/*.tsx",
-                ".next/types/**/*.ts",
-            ],
-            exclude: ["node_modules"],
-        }, null, 2);
+        return tsconfigTemplate;
     }
     async generateRootLayout() {
         const files = await this.getAllMDXFiles();
@@ -357,8 +402,11 @@ export default nextConfig;
         const layoutContent = await this.generateRootLayout();
         await fs.writeFile(path.join(this.outputDir, "app", "layout.tsx"), layoutContent, "utf8");
     }
-    generateHomePage() {
-        return homeTemplate;
+    generateHomeMdx() {
+        return homeMdxTemplate;
+    }
+    generateCommandsMdx() {
+        return commandsMdxTemplate;
     }
     generateNotFoundPage() {
         return notFoundTemplate;
@@ -405,49 +453,36 @@ export default nextConfig;
     generateOrderNavItems() {
         return orderNavItemsTemplate;
     }
-    stop() {
+    async stop() {
         if (this.watcher) {
-            this.watcher.close();
+            await this.watcher.close();
             console.log(chalk.yellow("👋 Stopped watching for changes"));
         }
     }
 }
-// CLI Commands
 program
     .name("doccupine")
     .description("Watch MDX files and generate Next.js documentation pages automatically")
-    .version("0.0.1");
+    .version("0.0.4");
 program
     .command("watch", { isDefault: true })
     .description("Watch a directory for MDX changes and generate Next.js app")
     .option("--port <port>", "Port for Next.js dev server", "3000")
     .option("--verbose", "Show verbose output")
+    .option("--reset", "Reset configuration and prompt for new directories")
     .action(async (options) => {
-    const questions = [
-        {
-            type: "text",
-            name: "watchDir",
-            message: "Enter directory to watch for MDX files:",
-            initial: "docs",
-        },
-        {
-            type: "text",
-            name: "outputDir",
-            message: "Enter output directory for Next.js app:",
-            initial: "nextjs-app",
-        },
-    ];
-    const { watchDir: watchDirInput, outputDir: outputDirInput } = (await prompts(questions));
-    const watchDir = path.resolve(process.cwd(), watchDirInput);
-    const outputDir = path.resolve(process.cwd(), outputDirInput);
-    const generator = new MDXToNextJSGenerator(watchDir, outputDir);
+    const configManager = new ConfigManager();
+    const config = await configManager.getConfig({
+        reset: options.reset,
+        port: options.port,
+    });
+    const generator = new MDXToNextJSGenerator(config.watchDir, config.outputDir);
     await generator.init();
     let devServer = null;
     console.log(chalk.blue("📦 Installing dependencies..."));
     const { spawn } = await import("child_process");
-    // Install dependencies first
     const install = spawn("npm", ["install"], {
-        cwd: outputDir,
+        cwd: config.outputDir,
         stdio: "pipe",
     });
     await new Promise((resolve, reject) => {
@@ -462,18 +497,16 @@ program
         });
         install.on("error", reject);
     });
-    // Start dev server
-    console.log(chalk.blue(`🚀 Starting Next.js dev server on port ${options.port}...`));
-    devServer = spawn("npm", ["run", "dev", "--", "--port", options.port], {
-        cwd: outputDir,
+    console.log(chalk.blue(`🚀 Starting Next.js dev server on port ${config.port}...`));
+    devServer = spawn("npm", ["run", "dev", "--", "--port", config.port], {
+        cwd: config.outputDir,
         stdio: ["ignore", "pipe", "pipe"],
     });
     devServer.stdout.on("data", (data) => {
         const output = data.toString();
         if (output.includes("Ready") || output.includes("started")) {
-            console.log(chalk.green(`🌐 Next.js ready at http://localhost:${options.port}`));
+            console.log(chalk.green(`🌐 Next.js ready at http://localhost:${config.port}`));
         }
-        // Filter out noisy Next.js logs, show important ones
         if (output.includes("compiled") ||
             output.includes("error") ||
             output.includes("Ready")) {
@@ -489,44 +522,56 @@ program
         console.error(chalk.red("❌ Error starting dev server:"), error);
     });
     await generator.startWatching();
-    // Handle graceful shutdown
-    process.on("SIGINT", () => {
+    process.on("SIGINT", async () => {
         console.log(chalk.yellow("\n🛑 Shutting down..."));
-        generator.stop();
+        await generator.stop();
         if (devServer) {
             devServer.kill();
         }
         process.exit(0);
     });
     console.log(chalk.green("🎉 Generator is running! Press Ctrl+C to stop."));
-    if (options.dev) {
-        console.log(chalk.cyan(`📝 Edit your MDX files in: ${watchDir}`));
-        console.log(chalk.cyan(`🌐 View changes at: http://localhost:${options.port}`));
-    }
+    console.log(chalk.cyan(`📝 Edit your MDX files in: ${config.watchDir}`));
+    console.log(chalk.cyan(`🌐 View changes at: http://localhost:${config.port}`));
 });
 program
     .command("build")
     .description("One-time build of Next.js app from MDX files")
-    .action(async () => {
-    const questions = [
-        {
-            type: "text",
-            name: "watchDir",
-            message: "Enter directory to watch for MDX files:",
-            initial: "docs",
-        },
-        {
-            type: "text",
-            name: "outputDir",
-            message: "Enter output directory for Next.js app:",
-            initial: "nextjs-app",
-        },
-    ];
-    const { watchDir: watchDirInput, outputDir: outputDirInput } = (await prompts(questions));
-    const watchDir = path.resolve(process.cwd(), watchDirInput);
-    const outputDir = path.resolve(process.cwd(), outputDirInput);
-    const generator = new MDXToNextJSGenerator(watchDir, outputDir);
+    .option("--reset", "Reset configuration and prompt for new directories")
+    .action(async (options) => {
+    const configManager = new ConfigManager();
+    const config = await configManager.getConfig({
+        reset: options.reset,
+    });
+    const generator = new MDXToNextJSGenerator(config.watchDir, config.outputDir);
     await generator.init();
     console.log(chalk.green("🎉 Build complete!"));
 });
+program
+    .command("config")
+    .description("Show or reset configuration")
+    .option("--show", "Show current configuration")
+    .option("--reset", "Reset configuration")
+    .action(async (options) => {
+    const configManager = new ConfigManager();
+    if (options.show) {
+        const config = await configManager.loadConfig();
+        if (config) {
+            console.log(chalk.blue("📄 Current configuration:"));
+            console.log(chalk.white("Watch Directory:"), chalk.cyan(path.relative(process.cwd(), config.watchDir)));
+            console.log(chalk.white("Output Directory:"), chalk.cyan(path.relative(process.cwd(), config.outputDir)));
+            console.log(chalk.white("Port:"), chalk.cyan(config.port || "3000"));
+        }
+        else {
+            console.log(chalk.yellow("⚠️ No configuration file found"));
+        }
+    }
+    else if (options.reset) {
+        await configManager.getConfig({ reset: true });
+        console.log(chalk.green("✅ Configuration reset"));
+    }
+    else {
+        console.log(chalk.blue("Use --show to display configuration or --reset to reset it"));
+    }
+});
 program.parse();

package/dist/templates/commands.mdx.d.ts

@@ -0,0 +1 @@
+export declare const commandsMdxTemplate = "---\ntitle: \"Commands\"\ndescription: \"Doccupine CLI commands\"\ndate: \"2025-01-15\"\ncategory: \"General\"\ncategoryOrder: 0\norder: 1\n---\n# Commands\n\nIn this page, you can find all the commands available in Doccupine CLI.\n\n- **Run Doccupine CLI:**\n\nCreate a new directory for your project and navigate to it in your terminal. Run the following command to create a new Doccupine project:\n\n~~~bash\nnpx doccupine\n~~~\n\nOnce 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.\nAfter 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.\n\nThis will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.\n\n- **Generate the website:**\n\n~~~bash\nnpx doccupine build\n~~~\n\nThis will generate the build files for your documentation website without starting the development server. You can then deploy the generated files to a hosting service of your choice.\n\n- **Show current configuration:**\n\n~~~bash\nnpx doccupine config --show\n~~~\n\nThis will show the current configuration for Doccupine.\n\n- **Reset configuration:**\n\n~~~bash\nnpx doccupine config --reset\n~~~\n  \nThis will reset the current configuration for Doccupine.";

package/dist/templates/commands.mdx.js

@@ -0,0 +1,48 @@
+export const commandsMdxTemplate = `---
+title: "Commands"
+description: "Doccupine CLI commands"
+date: "2025-01-15"
+category: "General"
+categoryOrder: 0
+order: 1
+---
+# Commands
+
+In this page, you can find all the commands available in Doccupine CLI.
+
+- **Run Doccupine CLI:**
+
+Create a new directory for your project and navigate to it in your terminal. Run the following command to create a new Doccupine project:
+
+~~~bash
+npx doccupine
+~~~
+
+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.
+
+This will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.
+
+- **Generate the website:**
+
+~~~bash
+npx doccupine build
+~~~
+
+This will generate the build files for your documentation website without starting the development server. You can then deploy the generated files to a hosting service of your choice.
+
+- **Show current configuration:**
+
+~~~bash
+npx doccupine config --show
+~~~
+
+This will show the current configuration for Doccupine.
+
+- **Reset configuration:**
+
+~~~bash
+npx doccupine config --reset
+~~~
+  
+This will reset the current configuration for Doccupine.`;

package/dist/templates/home.mdx.d.ts

@@ -0,0 +1 @@
+export declare const homeMdxTemplate = "---\ntitle: \"Getting Started\"\ndescription: \"This is my first Doccupine project\"\ndate: \"2025-01-15\"\ncategory: \"General\"\ncategoryOrder: 0\norder: 0\n---\n# Welcome to Doccupine\n\nDoccupine 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.\n\n## Open Source and Extensible\nDoccupine 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\u2019s look and features to match your organization\u2019s requirements.\n\n## Features\n\n- \uD83D\uDCDD Markdown-based content\n- \uD83D\uDCE6 Built-in file structure\n- \u26A1 Live Preview & Auto-Update\n- \uD83D\uDE80 Easy Deployment\n\n## Getting Started\n\nTo get started with Doccupine, make sure you have [Node.js](https://nodejs.org) and npm installed on your machine. Then, follow these steps:\n\n- **Run Doccupine CLI:**\n\nCreate a new directory for your project and navigate to it in your terminal. Run the following command to create a new Doccupine project:\n\n~~~bash\nnpx doccupine\n~~~\n\nOnce 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.\nAfter 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.\n\nThis will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.\n\n## Start documenting\nStart documenting your project by editing the **index.mdx** file in the choosen MDX directory.\n\nIn 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.\n";

package/dist/templates/home.mdx.js

@@ -0,0 +1,44 @@
+export const homeMdxTemplate = `---
+title: "Getting Started"
+description: "This is my first Doccupine project"
+date: "2025-01-15"
+category: "General"
+categoryOrder: 0
+order: 0
+---
+# Welcome to Doccupine
+
+Doccupine 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.
+
+## 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.
+
+## Features
+
+- 📝 Markdown-based content
+- 📦 Built-in file structure
+- ⚡ Live Preview & Auto-Update
+- 🚀 Easy Deployment
+
+## Getting Started
+
+To get started with Doccupine, make sure you have [Node.js](https://nodejs.org) and npm installed on your machine. Then, follow these steps:
+
+- **Run Doccupine CLI:**
+
+Create a new directory for your project and navigate to it in your terminal. Run the following command to create a new Doccupine project:
+
+~~~bash
+npx doccupine
+~~~
+
+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.
+
+This will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.
+
+## Start documenting
+Start documenting your project by editing the **index.mdx** file in the choosen MDX directory.
+
+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.
+`;

package/dist/templates/homemdx.d.ts

@@ -0,0 +1 @@
+export declare const homeMdxTemplate = "---\ntitle: \"Home\"\ndescription: \"This is my first Doccupine project\"\ndate: \"2025-01-15\"\ncategory: \"General\"\ncategoryOrder: 0\norder: 0\n---\n# Welcome to Doccupine\n\nDoccupine 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.\n\n## Open Source and Extensible\nDoccupine 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\u2019s look and features to match your organization\u2019s requirements.\n\n## Getting Started\n\nTo get started with Doccupine, make sure you have [Node.js](https://nodejs.org) and npm installed on your machine. Then, follow these steps:\n\n- **Run Doccupine CLI:**\n\nCreate a new directory for your project and navigate to it in your terminal. Run the following command to create a new Doccupine project:\n\n~~~bash\nnpx doccupine\n~~~\n\nOnce 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.\nAfter 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.\n\nThis will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.\n\n- **Generate the website:**\n\n~~~bash\nnpx doccupine build\n~~~\n\nThis will generate the build files for your documentation website without starting the development server. You can then deploy the generated files to a hosting service of your choice.\n\n## Features\n\n- \uD83D\uDCDD Markdown-based content\n- \uD83D\uDCE6 Built-in file structure\n- \u26A1 Live Preview & Auto-Update\n- \uD83D\uDE80 Easy Deployment\n\n## Start documenting\nStart documenting your project by creating a new **index.mdx** file in the choosen MDX directory. You can use the following template as a starting point:\n\n~~~text\n\n# Home\n\nThis is some **markdown** content with MDX support.\n~~~\n\nIn 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.\n";

package/dist/templates/homemdx.js

@@ -0,0 +1,59 @@
+export const homeMdxTemplate = `---
+title: "Home"
+description: "This is my first Doccupine project"
+date: "2025-01-15"
+category: "General"
+categoryOrder: 0
+order: 0
+---
+# Welcome to Doccupine
+
+Doccupine 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.
+
+## 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.
+
+## Getting Started
+
+To get started with Doccupine, make sure you have [Node.js](https://nodejs.org) and npm installed on your machine. Then, follow these steps:
+
+- **Run Doccupine CLI:**
+
+Create a new directory for your project and navigate to it in your terminal. Run the following command to create a new Doccupine project:
+
+~~~bash
+npx doccupine
+~~~
+
+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.
+
+This will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.
+
+- **Generate the website:**
+
+~~~bash
+npx doccupine build
+~~~
+
+This will generate the build files for your documentation website without starting the development server. You can then deploy the generated files to a hosting service of your choice.
+
+## Features
+
+- 📝 Markdown-based content
+- 📦 Built-in file structure
+- ⚡ Live Preview & Auto-Update
+- 🚀 Easy Deployment
+
+## Start documenting
+Start documenting your project by creating a new **index.mdx** file in the choosen MDX directory. You can use the following template as a starting point:
+
+~~~text
+
+# Home
+
+This is some **markdown** content with MDX support.
+~~~
+
+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.
+`;

package/dist/templates/next.config.d.ts

@@ -0,0 +1 @@
+export declare const nextConfigTemplate = "import type { NextConfig } from \"next\";\n\nconst nextConfig: NextConfig = {\n  compiler: {\n    styledComponents: true,\n  },\n  transpilePackages: [\"lucide-react\"],\n};\n\nexport default nextConfig;\n";

package/dist/templates/next.config.js

@@ -0,0 +1,11 @@
+export const nextConfigTemplate = `import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  compiler: {
+    styledComponents: true,
+  },
+  transpilePackages: ["lucide-react"],
+};
+
+export default nextConfig;
+`;

package/dist/templates/package.d.ts

@@ -0,0 +1 @@
+export declare const packageJsonTemplate: string;

package/dist/templates/package.js

@@ -0,0 +1,34 @@
+export const packageJsonTemplate = JSON.stringify({
+    name: "doccupine",
+    version: "0.1.0",
+    private: true,
+    scripts: {
+        dev: "next dev",
+        build: "next build",
+        start: "next start",
+        lint: "next lint",
+    },
+    dependencies: {
+        next: "15.5.2",
+        react: "19.1.1",
+        "react-dom": "19.1.1",
+    },
+    devDependencies: {
+        "@types/node": "^24",
+        "@types/react": "^19",
+        "@types/react-dom": "^19",
+        "cherry-styled-components": "^0.1.0-43",
+        eslint: "^9",
+        "eslint-config-next": "15.5.2",
+        "lucide-react": "^0.542.0",
+        polished: "^4.3.1",
+        prettier: "^3.6.2",
+        "react-markdown": "^10.1.0",
+        "rehype-highlight": "^7.0.2",
+        "rehype-parse": "^9.0.1",
+        "rehype-stringify": "^10.0.1",
+        "remark-gfm": "^4.0.1",
+        "styled-components": "^6.1.19",
+        typescript: "^5",
+    },
+}, null, 2);

package/dist/templates/tsconfig.d.ts

@@ -0,0 +1 @@
+export declare const tsconfigTemplate: string;

package/dist/templates/tsconfig.js

@@ -0,0 +1,24 @@
+export const tsconfigTemplate = JSON.stringify({
+    compilerOptions: {
+        target: "es5",
+        lib: ["dom", "dom.iterable", "es6"],
+        allowJs: true,
+        skipLibCheck: true,
+        strict: true,
+        noEmit: true,
+        esModuleInterop: true,
+        module: "esnext",
+        moduleResolution: "bundler",
+        resolveJsonModule: true,
+        isolatedModules: true,
+        jsx: "preserve",
+        incremental: true,
+        plugins: [{ name: "next" }],
+        baseUrl: ".",
+        paths: {
+            "@/*": ["./*"],
+        },
+    },
+    include: ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+    exclude: ["node_modules"],
+}, null, 2);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doccupine",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "CLI tool to watch MDX files and generate Next.js beautiful documentation pages automatically",
   "main": "dist/index.js",
   "bin": {
@@ -35,7 +35,7 @@
   "devDependencies": {
     "@types/chokidar": "^2.1.7",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^24.3.0",
+    "@types/node": "^24.3.1",
     "@types/prompts": "^2.4.9",
     "typescript": "^5.9.2"
   },