doccupine 0.0.3 → 0.0.4
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.
- package/README.md +8 -31
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,13 @@ Doccupine is a free and open-source document management system that allows you t
|
|
|
6
6
|
|
|
7
7
|
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.
|
|
8
8
|
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- 📝 Markdown-based content
|
|
12
|
+
- 📦 Built-in file structure
|
|
13
|
+
- ⚡ Live Preview & Auto-Update
|
|
14
|
+
- 🚀 Easy Deployment
|
|
15
|
+
|
|
9
16
|
## Getting Started
|
|
10
17
|
|
|
11
18
|
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
|
|
|
23
30
|
|
|
24
31
|
This will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.
|
|
25
32
|
|
|
26
|
-
- **Generate the website:**
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npx doccupine build
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
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.
|
|
33
|
-
|
|
34
|
-
## Features
|
|
35
|
-
|
|
36
|
-
- 📝 Markdown-based content
|
|
37
|
-
- 📦 Built-in file structure
|
|
38
|
-
- ⚡ Live Preview & Auto-Update
|
|
39
|
-
- 🚀 Easy Deployment
|
|
40
|
-
|
|
41
33
|
## Start documenting
|
|
42
34
|
|
|
43
|
-
Start documenting your project by
|
|
44
|
-
|
|
45
|
-
```text
|
|
46
|
-
---
|
|
47
|
-
title: "Home"
|
|
48
|
-
description: "This is my first Doccupine project"
|
|
49
|
-
date: "2025-01-15"
|
|
50
|
-
category: "General"
|
|
51
|
-
categoryOrder: 0
|
|
52
|
-
order: 0
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
# Home
|
|
56
|
-
|
|
57
|
-
This is some **markdown** content with MDX support.
|
|
58
|
-
```
|
|
35
|
+
Start documenting your project by editing the **index.mdx** file in the choosen MDX directory.
|
|
59
36
|
|
|
60
37
|
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
CHANGED
|
@@ -463,7 +463,7 @@ export default function Home() {
|
|
|
463
463
|
program
|
|
464
464
|
.name("doccupine")
|
|
465
465
|
.description("Watch MDX files and generate Next.js documentation pages automatically")
|
|
466
|
-
.version("0.0.
|
|
466
|
+
.version("0.0.4");
|
|
467
467
|
program
|
|
468
468
|
.command("watch", { isDefault: true })
|
|
469
469
|
.description("Watch a directory for MDX changes and generate Next.js app")
|