@mgks/docmd 0.4.4 → 0.4.5
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/LICENSE +1 -1
- package/README.md +27 -3
- package/bin/docmd.js +14 -0
- package/package.json +2 -2
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
##
|
|
1
|
+
## @mgks/docmd [MOVED]
|
|
2
2
|
|
|
3
|
-
⚠️ **THIS PACKAGE HAS BEEN RENAMED.** ⚠️
|
|
3
|
+
⚠️ **THIS PACKAGE HAS BEEN MOVED & RENAMED.** ⚠️
|
|
4
4
|
|
|
5
5
|
We have moved! Please use **[@docmd/core](https://www.npmjs.com/package/@docmd/core)** for all future updates.
|
|
6
6
|
|
|
@@ -19,4 +19,28 @@ We have moved! Please use **[@docmd/core](https://www.npmjs.com/package/@docmd/c
|
|
|
19
19
|
## What is this?
|
|
20
20
|
This package is a legacy wrapper. It currently forwards all commands to the new `@docmd/core` engine to prevent breaking existing CI/CD pipelines, but **it will not receive new features**.
|
|
21
21
|
|
|
22
|
-
Please update your scripts to use `@docmd/core`.
|
|
22
|
+
Please update your scripts to use `@docmd/core`.
|
|
23
|
+
|
|
24
|
+
## The docmd Ecosystem
|
|
25
|
+
|
|
26
|
+
`docmd` is a modular system. Here are the official packages:
|
|
27
|
+
|
|
28
|
+
**The Engine**
|
|
29
|
+
* [**@docmd/core**](https://www.npmjs.com/package/@docmd/core) - The CLI runner and build orchestrator.
|
|
30
|
+
* [**@docmd/parser**](https://www.npmjs.com/package/@docmd/parser) - The pure Markdown-to-HTML logic.
|
|
31
|
+
* [**@docmd/live**](https://www.npmjs.com/package/@docmd/live) - The browser-based Live Editor bundle.
|
|
32
|
+
|
|
33
|
+
**Interface & Design**
|
|
34
|
+
* [**@docmd/ui**](https://www.npmjs.com/package/@docmd/ui) - Base EJS templates and assets.
|
|
35
|
+
* [**@docmd/themes**](https://www.npmjs.com/package/@docmd/themes) - Official themes (Sky, Ruby, Retro).
|
|
36
|
+
|
|
37
|
+
**Plugins**
|
|
38
|
+
* [**@docmd/plugin-search**](https://www.npmjs.com/package/@docmd/plugin-search) - Offline full-text search.
|
|
39
|
+
* [**@docmd/plugin-mermaid**](https://www.npmjs.com/package/@docmd/plugin-mermaid) - Diagrams and flowcharts.
|
|
40
|
+
* [**@docmd/plugin-seo**](https://www.npmjs.com/package/@docmd/plugin-seo) - Meta tags and Open Graph data.
|
|
41
|
+
* [**@docmd/plugin-sitemap**](https://www.npmjs.com/package/@docmd/plugin-sitemap) - Automatic sitemap generation.
|
|
42
|
+
* [**@docmd/plugin-analytics**](https://www.npmjs.com/package/@docmd/plugin-analytics) - Google Analytics integration.
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
Distributed under the MIT License. See `LICENSE` for more information.
|
package/bin/docmd.js
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* --------------------------------------------------------------------
|
|
5
|
+
* docmd : the minimalist, zero-config documentation generator.
|
|
6
|
+
*
|
|
7
|
+
* @package @docmd/core (and ecosystem)
|
|
8
|
+
* @website https://docmd.io
|
|
9
|
+
* @repository https://github.com/docmd-io/docmd
|
|
10
|
+
* @license MIT
|
|
11
|
+
* @copyright Copyright (c) 2025 docmd.io
|
|
12
|
+
*
|
|
13
|
+
* [docmd-source] - Please do not remove this header.
|
|
14
|
+
* --------------------------------------------------------------------
|
|
15
|
+
*/
|
|
16
|
+
|
|
3
17
|
console.error('\x1b[33m%s\x1b[0m', '⚠️ DEPRECATION NOTICE:');
|
|
4
18
|
console.error('\x1b[33m%s\x1b[0m', ' You are using the legacy package "@mgks/docmd".');
|
|
5
19
|
console.error('\x1b[33m%s\x1b[0m', ' Please uninstall it and install "@docmd/core" for future updates.');
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mgks/docmd",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.5",
|
|
4
4
|
"description": "Legacy wrapper for docmd. Please use @docmd/core.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"docmd": "bin/docmd.js"
|
|
7
7
|
},
|
|
8
8
|
"dependencies": {
|
|
9
|
-
"@docmd/core": "^0.4.
|
|
9
|
+
"@docmd/core": "^0.4.5"
|
|
10
10
|
},
|
|
11
11
|
"keywords": [
|
|
12
12
|
"docmd",
|