@docubook/create 2.3.0 → 2.4.0

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

@@ -0,0 +1,60 @@
+---
+title : Quick Start Guide
+description : a quick way to understand how to use it
+date : 10-12-2024
+---
+
+## Adding a Route
+
+To add a new page to your documentation, you need to register it in the `docu.json` file.
+
+<Stepper>
+  <StepperItem title="Create the MDX file">
+    Create a new `.mdx` file in the `docs` directory. For example, `docs/my-new-page.mdx`.
+  </StepperItem>
+  <StepperItem title="Register in docu.json">
+    Open `docu.json` and add an entry to the `routes` array.
+
+    ```json
+    {
+      "title": "My New Page",
+      "href": "/my-new-page"
+    }
+    ```
+  </StepperItem>
+</Stepper>
+
+## Writing Content
+
+DocuBook supports standard Markdown and a variety of custom components to make your documentation more interactive.
+
+### Using Components
+
+Here are some common components you can use:
+
+#### Cards
+
+Use cards to highlight important links or features.
+
+<CardGroup cols={2}>
+  <Card title="Installation" icon="Download" href="#">
+    Learn how to install DocuBook.
+  </Card>
+  <Card title="Configuration" icon="Settings" href="#">
+    Configure your documentation site.
+  </Card>
+</CardGroup>
+
+#### Notes
+
+Use notes to provide additional context or warnings.
+
+<Note type="warning" title="Warning">
+  Always remember to back up your configuration files.
+</Note>
+
+<Note type="note" title="Pro Tip">
+  You can use Lucide icons in your cards by specifying the `icon` prop.
+</Note>
+
+For more details on available components, check out the [Components](/docs/components) section.

package/src/dist/docu.json

@@ -21,7 +21,7 @@
   "repository": {
     "url": "https://github.com/DocuBook/docubook",
     "editPathTemplate": "/blob/main/{filePath}",
-    "editLink": true
+    "editLink": false
   },
   "sponsor": {
     "title": "Hosted on",
@@ -63,41 +63,44 @@
       "href": "/getting-started",
       "noLink": true,
       "context": {
-              "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" }
-              ]
+        "icon": "Book",
+        "description": "Set up your Documentation",
+        "title": "Guides"
       },
-      {
-      "title": "Api Reference",
-      "href": "/api-reference",
+      "items": [
+        { "title": "Introduction", "href": "/introduction" },
+        { "title": "Quick Start Guide", "href": "/quick-start-guide" }
+      ]
+    },
+    {
+      "title": "Components",
+      "href": "/components",
       "noLink": true,
       "context": {
-              "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" }
-              ]
+        "icon": "Layers",
+        "description": "Write with Markdown",
+        "title": "Markdown"
       },
-      {
-      "title": "Changelog",
-      "href": "/changelog",
-      "noLink": true,
-      "context": {
-              "icon": "History",
-              "description": "Update and Changes",
-              "title": "Release"
-              }
-      }
+      "items": [
+        { "title": "Accordion", "href": "/accordion" },
+        { "title": "Accordion Group", "href": "/accordion-group" },
+        { "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": "Tables", "href": "/tables" },
+        { "title": "Youtube", "href": "/youtube" },
+        { "title": "Custom", "href": "/custom" }
+      ]
+    }
     ]
 }

package/src/dist/eslint.config.mjs

@@ -1,35 +1,22 @@
-import { defineConfig } from "eslint/config";
 import nextCoreWebVitals from "eslint-config-next/core-web-vitals";
 import nextTypescript from "eslint-config-next/typescript";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
 import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
+import tseslint from "typescript-eslint";
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-    baseDirectory: __dirname,
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all
-});
-
-export default defineConfig([{
-    extends: [
-        ...nextCoreWebVitals,
-        ...nextTypescript,
-        ...compat.extends("plugin:@typescript-eslint/recommended")
-    ],
-
-    rules: {
-        "@typescript-eslint/no-explicit-any": "warn",
-
-        "@typescript-eslint/no-unused-vars": ["warn", {
-            argsIgnorePattern: "^_",
-            varsIgnorePattern: "^_",
-            caughtErrorsIgnorePattern: "^_",
-        }],
-
-        "@typescript-eslint/no-empty-object-type": "off",
+export default tseslint.config(
+    js.configs.recommended,
+    ...nextCoreWebVitals,
+    ...nextTypescript,
+    ...tseslint.configs["recommended"],
+    {
+        rules: {
+            "@typescript-eslint/no-explicit-any": "warn",
+            "@typescript-eslint/no-unused-vars": ["warn", {
+                argsIgnorePattern: "^_",
+                varsIgnorePattern: "^_",
+                caughtErrorsIgnorePattern: "^_",
+            }],
+            "@typescript-eslint/no-empty-object-type": "off",
+        },
     },
-}]);
+);

package/src/dist/lib/markdown.ts

@@ -6,7 +6,7 @@ import rehypePrism from "rehype-prism-plus";
 import rehypeAutolinkHeadings from "rehype-autolink-headings";
 import rehypeSlug from "rehype-slug";
 import rehypeCodeTitles from "rehype-code-titles";
-import { page_routes, ROUTES } from "./routes-config";
+import { page_routes, ROUTES } from "./routes";
 import { visit } from "unist-util-visit";
 import type { Node, Parent } from "unist";
 import matter from "gray-matter";
@@ -163,17 +163,20 @@ export type BaseMdxFrontmatter = {
 
 export async function getDocsForSlug(slug: string) {
   try {
-    const contentPath = getDocsContentPath(slug);
-    const rawMdx = await fs.readFile(contentPath, "utf-8");
-    return await parseMdx<BaseMdxFrontmatter>(rawMdx);
+    const { content, filePath } = await getRawMdx(slug);
+    const mdx = await parseMdx<BaseMdxFrontmatter>(content);
+    return {
+      ...mdx,
+      filePath,
+    };
   } catch (err) {
     console.log(err);
   }
 }
 
 export async function getDocsTocs(slug: string) {
-  const contentPath = getDocsContentPath(slug);
-  const rawMdx = await fs.readFile(contentPath, "utf-8");
+  const { content } = await getRawMdx(slug);
+  const rawMdx = content;
 
   // Regex to match code blocks (```...```), standard markdown headings (##), and <Release> tags
   const combinedRegex = /(```[\s\S]*?```)|^(#{2,4})\s(.+)$|<Release[^>]*version="([^"]+)"/gm;
@@ -222,8 +225,26 @@ function sluggify(text: string) {
   return slug.replace(/[^a-z0-9-]/g, "");
 }
 
-function getDocsContentPath(slug: string) {
-  return path.join(process.cwd(), "/docs/", `${slug}/index.mdx`);
+async function getRawMdx(slug: string) {
+  const commonPath = path.join(process.cwd(), "/docs/");
+  const paths = [
+    path.join(commonPath, `${slug}.mdx`),
+    path.join(commonPath, slug, "index.mdx"),
+  ];
+
+  for (const p of paths) {
+    try {
+      const content = await fs.readFile(p, "utf-8");
+      return {
+        content,
+        filePath: `docs/${path.relative(commonPath, p)}`,
+      };
+    } catch {
+      // ignore and try next
+    }
+  }
+
+  throw new Error(`Could not find mdx file for slug: ${slug}`);
 }
 
 function justGetFrontmatterFromMD<Frontmatter>(rawMd: string): Frontmatter {
@@ -245,16 +266,10 @@ export async function getAllChilds(pathString: string) {
 
   return await Promise.all(
     page_routes_copy.map(async (it) => {
-      const totalPath = path.join(
-        process.cwd(),
-        "/docs/",
-        prevHref,
-        it.href,
-        "index.mdx"
-      );
-      const raw = await fs.readFile(totalPath, "utf-8");
+      const slug = path.join(prevHref, it.href);
+      const { content } = await getRawMdx(slug);
       return {
-        ...justGetFrontmatterFromMD<BaseMdxFrontmatter>(raw),
+        ...justGetFrontmatterFromMD<BaseMdxFrontmatter>(content),
         href: `/docs${prevHref}${it.href}`,
       };
     })

package/src/dist/lib/utils.ts

@@ -1,6 +1,6 @@
 import { type ClassValue, clsx } from "clsx";
 import { twMerge } from "tailwind-merge";
-import { EachRoute, ROUTES } from "./routes-config";
+import { EachRoute, ROUTES } from "./routes";
 
 export function cn(...inputs: ClassValue[]) {
   return twMerge(clsx(inputs));

package/src/dist/next.config.mjs

@@ -1,14 +1,13 @@
 /** @type {import('next').NextConfig} */
 const nextConfig = {
-  images: {
-    remotePatterns: [
-      {
-        protocol: "https",
-        hostname: "**",
-      },
-    ],
-  },
-};
-
-export default nextConfig;
+    images: {
+        remotePatterns: [
+            {
+                protocol: "https",
+                hostname: "**",
+            },
+        ],
+    },
+}
 
+export default nextConfig

package/src/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docubook",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "private": true,
   "scripts": {
     "dev": "next dev",

package/src/dist/docs/api-reference/delete/index.mdx

@@ -1,63 +0,0 @@
----
-title : Delete
-description : example api DELETE
-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](/images/example-img.png)
-```
-
-render as :
-![Alt text for the image](/images/example-img.png)
-
-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/docs/api-reference/fetch/index.mdx

@@ -1,63 +0,0 @@
----
-title : Fetch
-description : example api FETCH
-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](/images/example-img.png)
-```
-
-render as :
-![Alt text for the image](/images/example-img.png)
-
-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/docs/api-reference/get/index.mdx

@@ -1,63 +0,0 @@
----
-title : Get
-description : example api GET
-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](/images/example-img.png)
-```
-
-render as :
-![Alt text for the image](/images/example-img.png)
-
-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/docs/api-reference/post/index.mdx

@@ -1,63 +0,0 @@
----
-title : Post
-description : example api POST
-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](/images/example-img.png)
-```
-
-render as :
-![Alt text for the image](/images/example-img.png)
-
-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/docs/changelog/index.mdx

@@ -1,49 +0,0 @@
----
-title : Changelog
-description : changelog version
-date : 10-12-2024
----
-
-## Output Markdown
-
-```
-<Release version="1.0.0" date="2025-08-10" title="Release version 1.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>
-```
-
-## Render as
-
-<Release version="1.0.0" date="2025-08-10" title="Release version 1.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>