elseware-docs-engine 1.0.0 → 1.0.1
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 +139 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,139 @@
|
|
|
1
|
-
# elseware Docs Engine
|
|
1
|
+
# elseware Docs Engine
|
|
2
|
+
|
|
3
|
+
A modern React documentation engine built for structured Markdown-based documentation websites with nested routing, sidebar generation, dark mode support, and responsive layouts.
|
|
4
|
+
|
|
5
|
+
Built with:
|
|
6
|
+
- React
|
|
7
|
+
- TypeScript
|
|
8
|
+
- Vite
|
|
9
|
+
- React Router
|
|
10
|
+
- elseware-ui
|
|
11
|
+
- MDXEditor
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Features
|
|
16
|
+
|
|
17
|
+
- Nested documentation structure
|
|
18
|
+
- Automatic sidebar generation
|
|
19
|
+
- Responsive mobile sidebar
|
|
20
|
+
- Markdown rendering
|
|
21
|
+
- Code block support
|
|
22
|
+
- Dark mode support
|
|
23
|
+
- Customizable base path
|
|
24
|
+
- TypeScript support
|
|
25
|
+
- Vite powered
|
|
26
|
+
- Clean documentation layouts
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Installation
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm install elseware-docs-engine
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Import Styles
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
import "elseware-docs-engine/dist/index.css";
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Basic Usage
|
|
47
|
+
|
|
48
|
+
```tsx
|
|
49
|
+
import React from "react";
|
|
50
|
+
|
|
51
|
+
import ReactDOM from "react-dom/client";
|
|
52
|
+
|
|
53
|
+
import { DocsEngine } from "elseware-docs-engine";
|
|
54
|
+
|
|
55
|
+
import docs from "./docs";
|
|
56
|
+
|
|
57
|
+
import "elseware-docs-engine/dist/index.css";
|
|
58
|
+
|
|
59
|
+
ReactDOM.createRoot(document.getElementById("root")!).render(
|
|
60
|
+
<React.StrictMode>
|
|
61
|
+
<DocsEngine
|
|
62
|
+
docs={docs}
|
|
63
|
+
basePath="/docs"
|
|
64
|
+
/>
|
|
65
|
+
</React.StrictMode>,
|
|
66
|
+
);
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Docs Structure Example
|
|
72
|
+
|
|
73
|
+
```ts
|
|
74
|
+
import intro from "./getting-started/intro.md?raw";
|
|
75
|
+
|
|
76
|
+
import { DocsCategory } from "elseware-docs-engine";
|
|
77
|
+
|
|
78
|
+
const docs: DocsCategory[] = [
|
|
79
|
+
{
|
|
80
|
+
title: "Getting Started",
|
|
81
|
+
|
|
82
|
+
path: "/getting-started",
|
|
83
|
+
|
|
84
|
+
children: [
|
|
85
|
+
{
|
|
86
|
+
title: "Introduction",
|
|
87
|
+
|
|
88
|
+
path: "/intro",
|
|
89
|
+
|
|
90
|
+
content: intro,
|
|
91
|
+
},
|
|
92
|
+
],
|
|
93
|
+
},
|
|
94
|
+
];
|
|
95
|
+
|
|
96
|
+
export default docs;
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Markdown Features
|
|
102
|
+
|
|
103
|
+
- Headings
|
|
104
|
+
- Tables
|
|
105
|
+
- Lists
|
|
106
|
+
- Images
|
|
107
|
+
- Links
|
|
108
|
+
- Quotes
|
|
109
|
+
- Code blocks
|
|
110
|
+
- Syntax highlighting
|
|
111
|
+
- Nested navigation
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Development
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
npm run dev
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## Build
|
|
124
|
+
|
|
125
|
+
```bash
|
|
126
|
+
npm run build
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## License
|
|
132
|
+
|
|
133
|
+
MIT License
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## Author
|
|
138
|
+
|
|
139
|
+
elseware Technology
|