mdsvr 2.2.12 → 2.2.13
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 +43 -4
- package/package.json +13 -4
package/README.md
CHANGED
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
# mdsvr
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/mdsvr)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
[](https://nodejs.org/)
|
|
6
|
+
|
|
7
|
+
[](https://mdsvr-docs.web.app/)
|
|
4
8
|
|
|
5
|
-
|
|
9
|
+
> **The fastest way from Markdown to beautiful docs.** Zero config, one command, 10 seconds.
|
|
10
|
+
|
|
11
|
+
📖 **[Official Documentation](https://mdsvr-docs.web.app/)**
|
|
12
|
+
|
|
13
|
+
Transform any folder of Markdown files into a full-featured documentation website — no build step, no configuration required.
|
|
6
14
|
|
|
7
15
|
```text
|
|
8
16
|
█ █ ████ ████ █ █ ████
|
|
@@ -16,8 +24,24 @@ Transform any folder of Markdown/Markdown files into a beautiful documentation w
|
|
|
16
24
|
|
|
17
25
|
```bash
|
|
18
26
|
npx mdsvr ./docs
|
|
27
|
+
# That's it. That's the whole setup.
|
|
19
28
|
```
|
|
20
29
|
|
|
30
|
+
## Why mdsvr?
|
|
31
|
+
|
|
32
|
+
| Feature | mdsvr | Docusaurus | Nextra | MkDocs |
|
|
33
|
+
| ---------------- | -------------- | ----------- | -------------- | ----------- |
|
|
34
|
+
| Setup time | **10 seconds** | 5 minutes | 3 minutes | 3 minutes |
|
|
35
|
+
| Config required | ❌ No | ✅ Yes | ✅ Yes | ✅ Yes |
|
|
36
|
+
| Build step | ❌ Not needed | ✅ Required | ✅ Required | ✅ Required |
|
|
37
|
+
| MDX support | ✅ Full | ✅ Full | ✅ Full | ❌ No |
|
|
38
|
+
| Full-text search | ✅ Client-side | Algolia API | ✅ Client-side | ✅ Built-in |
|
|
39
|
+
| Docker image | ✅ Official | DIY | DIY | DIY |
|
|
40
|
+
| Startup time | **150ms** | ~8.5s build | ~6.2s build | ~3s build |
|
|
41
|
+
| Language | Node.js | Node.js | Node.js | Python |
|
|
42
|
+
|
|
43
|
+
> mdsvr is **56× faster to start** than Docusaurus and requires **zero configuration**.
|
|
44
|
+
|
|
21
45
|
## Features
|
|
22
46
|
|
|
23
47
|
### Markdown & MDX Rendering
|
|
@@ -85,6 +109,9 @@ npx mdsvr ./notes --port 1800 --open
|
|
|
85
109
|
|
|
86
110
|
# Expose to LAN
|
|
87
111
|
npx mdsvr . --host 0.0.0.0 --port 1800
|
|
112
|
+
|
|
113
|
+
# Export to static HTML (Firebase, Netlify, GitHub Pages)
|
|
114
|
+
npx mdsvr ./docs --export
|
|
88
115
|
```
|
|
89
116
|
|
|
90
117
|
## Why Port 1800?
|
|
@@ -295,8 +322,8 @@ npm install -g firebase-tools
|
|
|
295
322
|
# Navigate to your docs directory
|
|
296
323
|
cd /path/to/your/docs
|
|
297
324
|
|
|
298
|
-
# Export static HTML
|
|
299
|
-
mdsvr -e
|
|
325
|
+
# Export static HTML to _html/public directory
|
|
326
|
+
mdsvr . -e
|
|
300
327
|
|
|
301
328
|
cd _html
|
|
302
329
|
|
|
@@ -365,6 +392,18 @@ docs/
|
|
|
365
392
|
|
|
366
393
|
- Node.js 18+
|
|
367
394
|
|
|
395
|
+
## Performance
|
|
396
|
+
|
|
397
|
+
| Tool | Startup / Build time |
|
|
398
|
+
| ---------- | -------------------- |
|
|
399
|
+
| **mdsvr** | **150ms** |
|
|
400
|
+
| Hugo | ~1s |
|
|
401
|
+
| MkDocs | ~3s |
|
|
402
|
+
| Nextra | ~6.2s |
|
|
403
|
+
| Docusaurus | ~8.5s |
|
|
404
|
+
|
|
405
|
+
mdsvr serves files directly — no build pipeline, no waiting.
|
|
406
|
+
|
|
368
407
|
## License
|
|
369
408
|
|
|
370
409
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mdsvr",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.13",
|
|
4
4
|
"description": "Full-featured documentation website server with MDX support, site settings, SEO, and navigation",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -57,11 +57,20 @@
|
|
|
57
57
|
},
|
|
58
58
|
"keywords": [
|
|
59
59
|
"markdown",
|
|
60
|
-
"serve",
|
|
61
|
-
"static",
|
|
62
60
|
"server",
|
|
63
61
|
"docs",
|
|
64
|
-
"
|
|
62
|
+
"documentation",
|
|
63
|
+
"mdx",
|
|
64
|
+
"static-site-generator",
|
|
65
|
+
"zero-config",
|
|
66
|
+
"serve",
|
|
67
|
+
"cli",
|
|
68
|
+
"dark-mode",
|
|
69
|
+
"search",
|
|
70
|
+
"seo",
|
|
71
|
+
"docusaurus-alternative",
|
|
72
|
+
"nextra-alternative",
|
|
73
|
+
"markdown-server"
|
|
65
74
|
],
|
|
66
75
|
"files": [
|
|
67
76
|
"dist/**/*",
|