@docubook/create 1.15.0 → 1.15.2

package/src/dist/contents/docs/changelog/version-2/index.mdx

@@ -0,0 +1,49 @@
+---
+title : Version 2
+description : changelog version
+date : 10-12-2024
+---
+
+## Render as
+
+<Release version="2.0.0" date="2025-08-10" title="Release version 2.0.0">
+  <Changes type="added">
+    - add components
+  </Changes>
+  <Changes type="fixed">
+    - fix globals.css
+  </Changes>
+  <Changes type="improved">
+    - improved search components
+  </Changes>
+  <Changes type="deprecated">
+    - deprecated footer components
+  </Changes>
+  <Changes type="removed">
+    - removed utility class
+    - removed unused hooks
+  </Changes>
+</Release>
+
+## Output Markdown
+
+```
+<Release version="2.0.0" date="2025-08-10" title="Release version 2.0.0">
+  <Changes type="added">
+    - add components
+  </Changes>
+  <Changes type="fixed">
+    - fix globals.css
+  </Changes>
+  <Changes type="improved">
+    - improved search components
+  </Changes>
+  <Changes type="deprecated">
+    - deprecated footer components
+  </Changes>
+  <Changes type="removed">
+    - removed utility class
+    - removed unused hooks
+  </Changes>
+</Release>
+```

package/src/dist/contents/docs/changelog/version-3/index.mdx

@@ -0,0 +1,49 @@
+---
+title : Version 3
+description : changelog version
+date : 10-12-2024
+---
+
+## Render as
+
+<Release version="3.0.0" date="2025-08-10" title="Release version 3.0.0">
+  <Changes type="added">
+    - add components
+  </Changes>
+  <Changes type="fixed">
+    - fix globals.css
+  </Changes>
+  <Changes type="improved">
+    - improved search components
+  </Changes>
+  <Changes type="deprecated">
+    - deprecated footer components
+  </Changes>
+  <Changes type="removed">
+    - removed utility class
+    - removed unused hooks
+  </Changes>
+</Release>
+
+## Output Markdown
+
+```
+<Release version="3.0.0" date="2025-08-10" title="Release version 3.0.0">
+  <Changes type="added">
+    - add components
+  </Changes>
+  <Changes type="fixed">
+    - fix globals.css
+  </Changes>
+  <Changes type="improved">
+    - improved search components
+  </Changes>
+  <Changes type="deprecated">
+    - deprecated footer components
+  </Changes>
+  <Changes type="removed">
+    - removed utility class
+    - removed unused hooks
+  </Changes>
+</Release>
+```

package/src/dist/contents/docs/getting-started/development/index.mdx

@@ -0,0 +1,63 @@
+---
+title : Development
+description : for Development server and production
+date : 10-12-2024
+---
+
+## Heading 2
+
+this is regular text written in markdown format with `inline code`, **bold**, and *italic*
+
+### Heading 3
+
+example of ordered list format :
+
+- list one
+        - sub list
+- list two
+- list three
+
+#### Heading 4
+
+Below is an example of how to write a code block :
+
+````plaintext
+```javascript:main.js showLineNumbers {3-4}
+function isRocketAboutToCrash() {
+    // Check if the rocket is stable
+    if (!isStable()) {
+        NoCrash(); // Prevent the crash
+    }
+}
+```
+````
+
+example note :
+```plaintext
+<Note type="note" title="Note">
+  This is a general note to convey information to the user.
+</Note>
+```
+
+displaying an image in markdown format :
+
+```plaintext
+![Alt text for the image](https://via.placeholder.com/150)
+```
+
+render as :
+![Alt text for the image](https://via.placeholder.com/150)
+
+For a complete guide on using markdown content in DocuBook, please refer to the [Components](https://docubook.pro/docs/components) page.
+
+<Note type="warning" title="Warning">
+  every page that is indexed in a folder will have an `index.mdx` file with metadata :
+  ```plaintext
+---
+title : Introduction
+description : overview or synopsis of a project
+date : 10-12-2024
+image : example-img.png
+---
+  ```
+</Note>

package/src/dist/contents/docs/getting-started/introduction/index.mdx

@@ -1,50 +1,63 @@
 ---
-title: Introduction
-description: This section provides an overview of DocuBook.
-date: 29-11-2024
-image: example-img.png
+title : Introduction
+description : overview or synopsis of a project
+date : 10-12-2024
 ---
 
-Welcome to **DocuBook**! This template provides a modern, flexible, and user-friendly foundation for creating engaging documentation. Whether you're building a knowledge base, project docs, or a personal blog, DocuBook makes it easy to set up and scale.
+## Heading 2
 
-## Open Source Philosophy
+this is regular text written in markdown format with `inline code`, **bold**, and *italic*
 
-DocuBook is proudly **open-source**! 🎉 We believe in creating an accessible, collaborative platform that thrives on community contributions.
+### Heading 3
 
-<Note title="Contribute">
-  Interested in helping us improve? Check out our [GitHub
-  repository](https://github.com/DocuBook/docubook) to get started! From
-  feature suggestions to bug fixes, all contributions are welcome.
-</Note>
+example of ordered list format :
+
+- list one
+        - sub list
+- list two
+- list three
+
+#### Heading 4
 
-## Project Overview
+Below is an example of how to write a code block :
 
-**DocuBook** is more than just a documentation template. It's a **complete toolkit** designed for modern web development. Key features include:
+````plaintext
+```javascript:main.js showLineNumbers {3-4}
+function isRocketAboutToCrash() {
+    // Check if the rocket is stable
+    if (!isStable()) {
+        NoCrash(); // Prevent the crash
+    }
+}
+```
+````
 
-- **Markdown & MDX Support:** Easily write documentation in Markdown, with the option to include interactive components via MDX.
-- **Customizable Themes:** Designed with a minimalist ShadCN-inspired theme that’s easy to style.
-- **SEO-Optimized:** Each page is SEO-ready, ensuring search engines can find and rank your content.
-- **Interactive Code Blocks:** Beautifully styled, language-specific code blocks for an enhanced reading experience.
+example note :
+```plaintext
+<Note type="note" title="Note">
+  This is a general note to convey information to the user.
+</Note>
+```
 
-### Key Features
+displaying an image in markdown format :
 
-| **Feature**                     | **Description**                                       |
-| ------------------------------- | ----------------------------------------------------- |
-| MDX Support                     | Write interactive documentation with MDX.             |
-| Nested Pages                    | Organize content in a nested, hierarchical structure. |
-| Pagination                      | Split content across multiple pages.                  |
-| Syntax Highlighting             | Highlight code for better readability.                |
-| Code Line Highlighting & Titles | Highlight specific lines with descriptive titles.     |
-| Interactive Code Blocks         | Language-specific and interactive code display.       |
-| Custom Markdown Components      | Embed custom, reusable components in your docs.       |
-| Static Site Generation          | Generate a static, high-performance site.             |
-| SEO-Optimized                   | Structured for optimal search engine indexing.        |
+```plaintext
+![Alt text for the image](https://via.placeholder.com/150)
+```
 
-## Technology & Libraries
+render as :
+![Alt text for the image](https://via.placeholder.com/150)
 
-DocuBook leverages cutting-edge technologies to ensure performance and flexibility:
+For a complete guide on using markdown content in DocuBook, please refer to the [Components](https://docubook.pro/docs/components) page.
 
-- **Next.js 14** - The powerful React framework optimized for production.
-- **Tailwind CSS** - Utility-first styling for quick, clean designs.
-- **Shadcn-UI** - Elegant, accessible components for a polished look.
-- **next-mdx-remote** - Enables MDX support for dynamic, interactive Markdown content.
+<Note type="warning" title="Warning">
+  every page that is indexed in a folder will have an `index.mdx` file with metadata :
+  ```plaintext
+---
+title : Introduction
+description : overview or synopsis of a project
+date : 10-12-2024
+image : example-img.png
+---
+  ```
+</Note>

package/src/dist/contents/docs/getting-started/quick-start-guide/index.mdx

@@ -1,145 +1,63 @@
 ---
-title: Quick Start Guide
-description: Get up and running with DocuBook in minutes with this comprehensive guide
-date: 20-05-2025
+title : Quick Start Guide
+description : a quick way to understand how to use it
+date : 10-12-2024
 ---
 
-Welcome to DocuBook! This guide will help you set up and customize your documentation site efficiently.
+## Heading 2
 
-## Prerequisites
+this is regular text written in markdown format with `inline code`, **bold**, and *italic*
 
-Before we begin, ensure you have the following installed:
+### Heading 3
 
-- [Git](https://git-scm.com/)
-- [Node.js 18+](https://nodejs.org/) or [Bun 1.0+](https://bun.sh/)
-- A package manager (npm, yarn, or pnpm)
+example of ordered list format :
 
-## Installation
+- list one
+        - sub list
+- list two
+- list three
 
-<Note type="note" title="Initial Setup">
-  Follow the [installation guide](/docs/getting-started/installation) to set up your project dependencies and configuration.
-</Note>
-
-## Project Setup
-
-### Configuration
-
-<Stepper>
-  <StepperItem title="Add Favicon">
-    Place your favicon at `public/favicon.ico` for browser tab display.
-  </StepperItem>
-  <StepperItem title="Add Logo">
-    Add your logo at `public/images/docu.svg` (SVG format recommended for scalability).
-  </StepperItem>
-  <StepperItem title="Update Site Information">
-    Customize your site's metadata in `docu.json`:
-    - Site title and description
-    - Navigation structure
-    - Default theme settings
-  </StepperItem>
-</Stepper>
+#### Heading 4
 
-## Content Management
+Below is an example of how to write a code block :
 
-### File Structure
-
-DocuBook organizes content in a hierarchical structure:
+````plaintext
+```javascript:main.js showLineNumbers {3-4}
+function isRocketAboutToCrash() {
+    // Check if the rocket is stable
+    if (!isStable()) {
+        NoCrash(); // Prevent the crash
+    }
+}
+```
+````
 
+example note :
 ```plaintext
-contents/
-  docs/                    # Main documentation directory
-    getting-started/        # Section for getting started guides
-      quick-start-guide/    # Current guide
-        index.mdx           # Main content file
-    guides/                # Additional documentation sections
-      components/          # Component-specific documentation
-        index.mdx
+<Note type="note" title="Note">
+  This is a general note to convey information to the user.
+</Note>
 ```
 
-### Creating New Content
-
-<Stepper>
-  <StepperItem title="1. Create Content Directory">
-    Organize your documentation by creating a new directory:
-    ```bash
-    mkdir -p contents/docs/your-section/your-topic
-    ```
-
-    Example for an API reference:
-    ```bash
-    mkdir -p contents/docs/api/authentication
-    ```
-  </StepperItem>
-
-  <StepperItem title="2. Create MDX Content">
-    Add an `index.mdx` file with frontmatter metadata:
-    ````markdown
-    ---
-    title: Authentication
-    description: Learn how to implement user authentication
-    date: 2025-05-29
-    ---
-
-    Your comprehensive guide to implementing authentication in your application.
-
-    ## Getting Started
-
-    Start by setting up your authentication provider...
-    ````
-  </StepperItem>
+displaying an image in markdown format :
 
-  <StepperItem title="3. Update Navigation">
-    Add your new section to the navigation in `docu.json`. Here's how to add the authentication section we created earlier:
-
-    ```json:docu.json showLineNumbers {4-16}
-    {
-      "routes": [
-        // ... existing routes ...
-        {
-          "title": "API",
-          "href": "/api",
-          "noLink": true,
-          "context": {
-            "icon": "Code2",
-            "description": "API Reference and Integration",
-            "title": "API"
-          },
-          "items": [
-            { "title": "Authentication", "href": "/authentication" }
-          ]
-        }
-      ]
-    }
-    ```
-
-    This will add a new "API" section with an "Authentication" page under it. The `context` object defines how this section appears in the navigation, including its icon and description.
-  </StepperItem>
-</Stepper>
-
-## Development Workflow
-
-### Local Development
-
-Start the development server with live reload:
-
-```bash
-# Using npm
-npm run dev
-
-# Or using Bun
-bun dev
+```plaintext
+![Alt text for the image](https://via.placeholder.com/150)
 ```
 
-Access your site at [http://localhost:3000](http://localhost:3000)
-
-### Building for Production
-
-When ready to deploy:
+render as :
+![Alt text for the image](https://via.placeholder.com/150)
 
-```bash
-# Build the production version
-npm run build
+For a complete guide on using markdown content in DocuBook, please refer to the [Components](https://docubook.pro/docs/components) page.
 
-# Start the production server
-npm start
-```
+<Note type="warning" title="Warning">
+  every page that is indexed in a folder will have an `index.mdx` file with metadata :
+  ```plaintext
+---
+title : Introduction
+description : overview or synopsis of a project
+date : 10-12-2024
+image : example-img.png
+---
+  ```
+</Note>

package/src/dist/docu.json

@@ -1,5 +1,12 @@
 {
-    "navbar": {
+  "$schema": "https://docubook.pro/docu.schema.json",
+  "meta": {
+    "baseURL": "https://docubook.pro",
+    "title": "DocuBook",
+    "description": "DocuBook is a modern documentation platform for building, deploying, and managing your docs with ease.",
+    "favicon": "/favicon.ico"
+  },
+  "navbar": {
       "logo": {
         "src": "/images/docu.svg",
         "alt": "DocuBook Logo"
@@ -10,120 +17,99 @@
         { "title": "Docs", "href": "/docs/getting-started/introduction" },
         { "title": "Community", "href": "https://docubook.pro" }
       ]
-    },
-    "footer": {
-      "copyright": "DocuBook",
-      "social": [
-        {
-            "name": "Instagram",
-            "url": "https://www.instagram.com/wildan.nrs",
-            "iconName": "InstagramIcon"
-        },
-        {
-            "name": "Facebook",
-            "url": "https://www.facebook.com/wildan.nrsh",
-            "iconName": "FacebookIcon"
-        },
-        {
-            "name": "Twitter",
-            "url": "https://x.com/wildan_nrss",
-            "iconName": "TwitterIcon"
-        },
-        {
-            "name": "Youtube",
-            "url": "https://www.youtube.com/@wildan.nrs_",
-            "iconName": "YoutubeIcon"
-        }
+  },
+  "repository": {
+    "url": "https://github.com/DocuBook/docubook",
+    "editPathTemplate": "/blob/main/{filePath}",
+    "editLink": true
+  },
+  "sponsor": {
+    "title": "Hosted on",
+    "item": {
+      "title": "Vercel",
+      "description": "Deploy your DocuBook app with zero configuration.",
+      "image": "/images/vercel.png",
+      "url": "https://vercel.com/import/project?template=https://github.com/DocuBook/docubook"
+    }
+  },
+  "footer": {
+    "copyright": "DocuBook",
+    "social": [
+      {
+          "name": "Instagram",
+          "url": "https://www.instagram.com/wildan.nrs",
+          "iconName": "InstagramIcon"
+      },
+      {
+          "name": "Facebook",
+          "url": "https://www.facebook.com/wildan.nrsh",
+          "iconName": "FacebookIcon"
+      },
+      {
+          "name": "Twitter",
+          "url": "https://x.com/wildan_nrss",
+          "iconName": "TwitterIcon"
+      },
+      {
+          "name": "Youtube",
+          "url": "https://www.youtube.com/@wildan.nrs_",
+          "iconName": "YoutubeIcon"
+      }
       ]
     },
-    "meta": {
-      "baseURL": "https://docubook.pro",
-      "title": "DocuBook",
-      "description": "DocuBook is a modern documentation platform for building, deploying, and managing your docs with ease.",
-      "favicon": "/favicon.ico"
-    },
-    "repository": {
-      "url": "https://github.com/DocuBook/docubook",
-      "editPathTemplate": "/blob/main/{filePath}",
-      "editLink": true
-    },
-    "sponsor": {
-        "title": "Hosted on",
-        "item": {
-        "title": "Vercel",
-        "description": "Deploy your DocuBook app with zero configuration.",
-        "image": "/images/vercel.png",
-        "url": "https://vercel.com/import/project?template=https://github.com/DocuBook/docubook"
-        }
-    },
     "routes": [
-    {
+      {
       "title": "Getting Started",
       "href": "/getting-started",
       "noLink": true,
       "context": {
-        "icon": "Book",
-        "description": "Set up your Documentation",
-        "title": "Guides"
+              "icon": "Book",
+              "description": "Set up your Documentation",
+              "title": "Guides"
+              },
+              "items": [
+                      { "title": "Introduction", "href": "/introduction" },
+                      { "title": "Quick Start Guide", "href": "/quick-start-guide" },
+                      { "title": "Development", "href": "/development" },
+                      {
+                              "title": "Config",
+                              "href": "/config",
+                              "items": [
+                                      { "title": "Sub Config", "href": "/subconfig" }
+                              ]
+                      }
+              ]
       },
-      "items": [
-        { "title": "Introduction", "href": "/introduction" },
-        { "title": "Installation", "href": "/installation" },
-        { "title": "Quick Start Guide", "href": "/quick-start-guide" },
-        { "title": "Project Structure", "href": "/project-structure" },
-        { "title": "Customize", "href": "/customize" },
-        {
-            "title": "Theme Colors",
-            "href": "/theme-colors",
-            "items": [
-                { "title": "Default", "href": "/default" },
-                { "title": "Fresh Lime", "href": "/freshlime" },
-                { "title": "Coffee", "href": "/coffee" },
-                { "title": "llms.txt", "href": "/llms" }
-            ]
-        }
-      ]
-    },
-    {
-      "title": "Components",
-      "href": "/components",
+      {
+      "title": "Api Reference",
+      "href": "/api-reference",
       "noLink": true,
       "context": {
-        "icon": "Layers",
-        "description": "Write with Markdown",
-        "title": "Markdown"
+              "icon": "Terminal",
+              "description": "reference for using the API",
+              "title": "API Reference"
+              },
+              "items": [
+                      { "title": "Get", "href": "/get" },
+                      { "title": "Fetch", "href": "/fetch" },
+                      { "title": "Post", "href": "/post" },
+                      { "title": "Delete", "href": "/delete" }
+              ]
       },
-      "items": [
-        { "title": "Accordion", "href": "/accordion" },
-        { "title": "Button", "href": "/button" },
-        { "title": "Card", "href": "/card" },
-        { "title": "Card Group", "href": "/card-group" },
-        { "title": "Code Block", "href": "/code-block" },
-        { "title": "File Tree", "href": "/file-tree" },
-        { "title": "Image", "href": "/image" },
-        { "title": "Keyboard", "href": "/keyboard" },
-        { "title": "Link", "href": "/link" },
-        { "title": "Note", "href": "/note" },
-        { "title": "Release Note", "href": "/release-note" },
-        { "title": "Stepper", "href": "/stepper" },
-        { "title": "Tabs", "href": "/tabs" },
-        { "title": "Tooltips", "href": "/tooltips" },
-        { "title": "Youtube", "href": "/youtube" },
-        { "title": "Custom", "href": "/custom" }
-      ]
-    },
-    {
-      "title": "Release",
-      "href": "/changelog",
+      {
+      "title": "Changelog",
+      "href": "/Changelog",
       "noLink": true,
       "context": {
-        "icon": "History",
-        "description": "Updates and changes",
-        "title": "Changelog"
-      },
-      "items": [
-        { "title": "Version 1.0+", "href": "/version-1" }
-      ]
-    }
-  ]
+              "icon": "Hystory",
+              "description": "Update and Changes",
+              "title": "Release"
+              },
+              "items": [
+                      { "title": "version 1", "href": "/version-1" },
+                      { "title": "version 2", "href": "/version-2" },
+                      { "title": "version 3", "href": "/version-3" }
+              ]
+      }
+    ]
 }