@mgks/docmd 0.3.5 → 0.3.7
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 +36 -25
- package/dist/assets/css/docmd-highlight-dark.css +1 -0
- package/dist/assets/css/docmd-highlight-light.css +1 -0
- package/dist/assets/css/docmd-main.css +1627 -0
- package/dist/assets/css/docmd-theme-retro.css +868 -0
- package/dist/assets/css/docmd-theme-ruby.css +629 -0
- package/dist/assets/css/docmd-theme-sky.css +618 -0
- package/dist/assets/favicon.ico +0 -0
- package/dist/assets/images/docmd-logo-dark.png +0 -0
- package/dist/assets/images/docmd-logo-light.png +0 -0
- package/dist/assets/images/docmd-logo.png +0 -0
- package/dist/assets/js/docmd-image-lightbox.js +74 -0
- package/dist/assets/js/docmd-main.js +222 -0
- package/dist/assets/js/docmd-mermaid.js +205 -0
- package/dist/assets/js/docmd-search.js +218 -0
- package/dist/assets/js/mermaid.min.js +2811 -0
- package/dist/assets/js/minisearch.js +2013 -0
- package/dist/docmd-live.js +30748 -0
- package/dist/index.html +201 -0
- package/dist/live.css +167 -0
- package/docmd.config.js +1 -1
- package/package.json +9 -8
- package/scripts/failsafe.js +37 -0
- package/src/assets/js/docmd-main.js +13 -5
- package/src/commands/dev.js +74 -8
- package/src/commands/init.js +29 -3
- package/src/live/templates.js +1 -1
- package/src/plugins/seo.js +2 -2
- package/src/templates/no-style.ejs +1 -1
package/README.md
CHANGED
|
@@ -1,32 +1,43 @@
|
|
|
1
1
|
<div align="center">
|
|
2
|
-
|
|
2
|
+
|
|
3
|
+
<!-- PROJECT TITLE -->
|
|
4
|
+
<h1>
|
|
3
5
|
<img src="https://github.com/mgks/docmd/blob/main/src/assets/images/docmd-logo-light.png?raw=true" alt="docmd logo" width="150" />
|
|
4
|
-
|
|
6
|
+
<!-- docmd -->
|
|
7
|
+
</h1>
|
|
8
|
+
|
|
9
|
+
<!-- ONE LINE SUMMARY -->
|
|
5
10
|
<p>
|
|
6
|
-
<
|
|
11
|
+
<b>The minimalist, zero-config documentation generator.</b>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
<!-- BADGES -->
|
|
15
|
+
<p>
|
|
16
|
+
<img src="https://img.shields.io/npm/v/@mgks/docmd.svg?style=flat-square&color=d25353" alt="npm version">
|
|
17
|
+
<img src="https://img.shields.io/github/commit-activity/m/mgks/docmd?style=flat-square&color=38bd24" alt="commits">
|
|
18
|
+
<img src="https://img.shields.io/npm/dt/@mgks/docmd.svg?style=flat-square&color=38bd24" alt="downloads">
|
|
19
|
+
<img src="https://img.shields.io/github/stars/mgks/docmd?style=flat-square&logo=github" alt="stars">
|
|
20
|
+
<img src="https://img.shields.io/github/license/mgks/docmd.svg?style=flat-square&color=blue" alt="license">
|
|
7
21
|
</p>
|
|
8
|
-
</div>
|
|
9
22
|
|
|
10
|
-
|
|
11
|
-
<
|
|
12
|
-
<
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
</
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
<
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
<sup><i>docmd noStyle page preview in dark mode</i></sup>
|
|
29
|
-
</p>
|
|
23
|
+
<!-- MENU -->
|
|
24
|
+
<p>
|
|
25
|
+
<h4>
|
|
26
|
+
<a href="https://docmd.mgks.dev">View Demo</a> •
|
|
27
|
+
<a href="https://docmd.mgks.dev/getting-started/installation/">Documentation</a> •
|
|
28
|
+
<a href="https://docmd.mgks.dev/live/">Live Editor</a> •
|
|
29
|
+
<a href="https://github.com/mgks/docmd/issues">Report Bug</a>
|
|
30
|
+
</h4>
|
|
31
|
+
</p>
|
|
32
|
+
|
|
33
|
+
<!-- PREVIEW -->
|
|
34
|
+
<p>
|
|
35
|
+
<img width="800" alt="docmd preview" src="https://github.com/user-attachments/assets/1a74d6f7-10f9-41fa-be8a-faeee278dbb9" />
|
|
36
|
+
<br/>
|
|
37
|
+
<sup><i>docmd noStyle page preview in light mode</i></sup>
|
|
38
|
+
</p>
|
|
39
|
+
|
|
40
|
+
</div>
|
|
30
41
|
|
|
31
42
|
## Features
|
|
32
43
|
|
|
@@ -155,4 +166,4 @@ Distributed under the MIT License. See `LICENSE` for more information.
|
|
|
155
166
|
|
|
156
167
|
> **{ github.com/mgks }**
|
|
157
168
|
>
|
|
158
|
-
>  
|
|
169
|
+
>  
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#abb2bf;background:#282c34}.hljs-comment,.hljs-quote{color:#5c6370;font-style:italic}.hljs-doctag,.hljs-formula,.hljs-keyword{color:#c678dd}.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#e06c75}.hljs-literal{color:#56b6c2}.hljs-addition,.hljs-attribute,.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#98c379}.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#d19a66}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#61aeee}.hljs-built_in,.hljs-class .hljs-title,.hljs-title.class_{color:#e6c07b}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-link{text-decoration:underline}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#383a42;background:#fafafa}.hljs-comment,.hljs-quote{color:#a0a1a7;font-style:italic}.hljs-doctag,.hljs-formula,.hljs-keyword{color:#a626a4}.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#e45649}.hljs-literal{color:#0184bb}.hljs-addition,.hljs-attribute,.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#50a14f}.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#986801}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#4078f2}.hljs-built_in,.hljs-class .hljs-title,.hljs-title.class_{color:#c18401}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-link{text-decoration:underline}
|