@markdown-viewer/documd 5.2.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 +99 -0
- package/browser-renderer.js +12638 -0
- package/documd.js +1050 -0
- package/package.json +51 -0
- package/stencils/alibaba_cloud.json +1 -0
- package/stencils/android.json +1 -0
- package/stencils/arrows.json +1 -0
- package/stencils/atlassian.json +1 -0
- package/stencils/aws.json +1 -0
- package/stencils/aws2.json +1 -0
- package/stencils/aws3.json +1 -0
- package/stencils/aws3d.json +1 -0
- package/stencils/aws4.json +1 -0
- package/stencils/azure.json +1 -0
- package/stencils/basic.json +1 -0
- package/stencils/bootstrap.json +1 -0
- package/stencils/bpmn.json +1 -0
- package/stencils/cabinets.json +1 -0
- package/stencils/cisco.json +1 -0
- package/stencils/cisco19.json +1 -0
- package/stencils/cisco_safe.json +1 -0
- package/stencils/citrix.json +1 -0
- package/stencils/citrix2.json +1 -0
- package/stencils/eip.json +1 -0
- package/stencils/electrical.json +1 -0
- package/stencils/floorplan.json +1 -0
- package/stencils/flowchart.json +1 -0
- package/stencils/fluid_power.json +1 -0
- package/stencils/gcp.json +1 -0
- package/stencils/gcp2.json +1 -0
- package/stencils/gmdl.json +1 -0
- package/stencils/ibm.json +1 -0
- package/stencils/ibm_cloud.json +1 -0
- package/stencils/index.json +298 -0
- package/stencils/ios7.json +1 -0
- package/stencils/kubernetes.json +1 -0
- package/stencils/kubernetes2.json +1 -0
- package/stencils/lean_mapping.json +1 -0
- package/stencils/mockup.json +1 -0
- package/stencils/mscae.json +1 -0
- package/stencils/networks.json +1 -0
- package/stencils/networks2.json +1 -0
- package/stencils/office.json +1 -0
- package/stencils/openstack.json +1 -0
- package/stencils/pid.json +1 -0
- package/stencils/rack.json +1 -0
- package/stencils/salesforce.json +1 -0
- package/stencils/signs.json +1 -0
- package/stencils/sitemap.json +1 -0
- package/stencils/veeam.json +1 -0
- package/stencils/vvd.json +1 -0
- package/stencils/webicons.json +1 -0
- package/stencils/weblogos.json +1 -0
- package/styles.css +1 -0
- package/themes/code-themes/business-contrast.json +31 -0
- package/themes/code-themes/colorful.json +32 -0
- package/themes/code-themes/cool-modern.json +31 -0
- package/themes/code-themes/dracula-code.json +31 -0
- package/themes/code-themes/light-clean.json +31 -0
- package/themes/code-themes/midnight-code.json +31 -0
- package/themes/code-themes/nord-code.json +31 -0
- package/themes/code-themes/solarized-dark-code.json +31 -0
- package/themes/code-themes/vscode-dark-code.json +31 -0
- package/themes/code-themes/vscode-light-code.json +31 -0
- package/themes/code-themes/warm-book.json +31 -0
- package/themes/color-schemes/candy.json +37 -0
- package/themes/color-schemes/carbon.json +37 -0
- package/themes/color-schemes/cool.json +37 -0
- package/themes/color-schemes/dracula-soft.json +37 -0
- package/themes/color-schemes/draft.json +37 -0
- package/themes/color-schemes/forest.json +37 -0
- package/themes/color-schemes/gruvbox-dark.json +37 -0
- package/themes/color-schemes/ink.json +37 -0
- package/themes/color-schemes/midnight.json +37 -0
- package/themes/color-schemes/neutral.json +37 -0
- package/themes/color-schemes/nord-dark.json +37 -0
- package/themes/color-schemes/obsidian.json +37 -0
- package/themes/color-schemes/ocean.json +37 -0
- package/themes/color-schemes/rainbow.json +46 -0
- package/themes/color-schemes/sakura.json +37 -0
- package/themes/color-schemes/sepia.json +37 -0
- package/themes/color-schemes/slate.json +37 -0
- package/themes/color-schemes/solarized-dark.json +37 -0
- package/themes/color-schemes/vscode-dark.json +45 -0
- package/themes/color-schemes/vscode-light.json +45 -0
- package/themes/color-schemes/warm.json +37 -0
- package/themes/font-config.json +211 -0
- package/themes/layout-schemes/book.json +40 -0
- package/themes/layout-schemes/compact.json +40 -0
- package/themes/layout-schemes/display.json +40 -0
- package/themes/layout-schemes/editorial.json +40 -0
- package/themes/layout-schemes/formal-paper.json +40 -0
- package/themes/layout-schemes/formal.json +40 -0
- package/themes/layout-schemes/magazine.json +40 -0
- package/themes/layout-schemes/regular.json +40 -0
- package/themes/layout-schemes/standard.json +40 -0
- package/themes/layout-schemes/vscode.json +62 -0
- package/themes/presets/academic.json +27 -0
- package/themes/presets/business.json +22 -0
- package/themes/presets/candy.json +23 -0
- package/themes/presets/carbon.json +18 -0
- package/themes/presets/century.json +22 -0
- package/themes/presets/default.json +29 -0
- package/themes/presets/dracula.json +18 -0
- package/themes/presets/elegant.json +22 -0
- package/themes/presets/forest.json +22 -0
- package/themes/presets/garamond.json +22 -0
- package/themes/presets/gruvbox.json +18 -0
- package/themes/presets/handwritten.json +23 -0
- package/themes/presets/heiti.json +22 -0
- package/themes/presets/magazine.json +24 -0
- package/themes/presets/manuscript.json +22 -0
- package/themes/presets/midnight.json +18 -0
- package/themes/presets/minimal.json +22 -0
- package/themes/presets/mixed.json +24 -0
- package/themes/presets/newspaper.json +24 -0
- package/themes/presets/nord.json +18 -0
- package/themes/presets/obsidian.json +18 -0
- package/themes/presets/ocean.json +22 -0
- package/themes/presets/official.json +29 -0
- package/themes/presets/palatino.json +22 -0
- package/themes/presets/rainbow.json +23 -0
- package/themes/presets/slate.json +18 -0
- package/themes/presets/solarized-dark.json +18 -0
- package/themes/presets/swiss.json +22 -0
- package/themes/presets/technical.json +22 -0
- package/themes/presets/typewriter.json +23 -0
- package/themes/presets/verdana.json +22 -0
- package/themes/presets/vscode-dark.json +24 -0
- package/themes/presets/vscode.json +24 -0
- package/themes/presets/water.json +22 -0
- package/themes/registry.json +116 -0
- package/themes/table-styles/academic.json +30 -0
- package/themes/table-styles/borderless.json +26 -0
- package/themes/table-styles/compact.json +24 -0
- package/themes/table-styles/grid.json +22 -0
- package/themes/table-styles/high-contrast.json +22 -0
- package/themes/table-styles/minimal-gray.json +26 -0
- package/themes/table-styles/modern-tech.json +34 -0
- package/themes/table-styles/professional.json +34 -0
- package/themes/table-styles/vscode-clean.json +26 -0
- package/themes/table-styles/zebra.json +22 -0
package/README.md
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# documd
|
|
2
|
+
|
|
3
|
+
The official CLI of [docu.md Markdown Viewer](https://docu.md).
|
|
4
|
+
|
|
5
|
+
Render Markdown, diagrams and GitBook books to **HTML, EPUB, DOCX, PDF, SVG, PNG
|
|
6
|
+
and DrawIO** with headless Chrome — powered by the docu.md Markdown Viewer
|
|
7
|
+
engine (the same renderers and exporters as the browser extension).
|
|
8
|
+
|
|
9
|
+
- Website: <https://docu.md>
|
|
10
|
+
- Source: <https://github.com/markdown-viewer/markdown-viewer-extension>
|
|
11
|
+
- Issues: <https://github.com/markdown-viewer/markdown-viewer-extension/issues>
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install -g @markdown-viewer/documd
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Version
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
documd --version
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
documd <input> [--format <f>] [-o <output>] [options]
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`--format` is inferred from the **output extension** when omitted:
|
|
32
|
+
|
|
33
|
+
- `-o out.epub` → epub, `-o out.pdf` → pdf, `-o out.png` → png, …
|
|
34
|
+
- no `-o`: markdown → html, diagram sources → svg, `--book` → epub
|
|
35
|
+
|
|
36
|
+
## Markdown documents
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
documd notes.md # notes.html
|
|
40
|
+
documd notes.md --format epub # notes.epub
|
|
41
|
+
documd notes.md -o report.pdf # PDF (inferred from the extension)
|
|
42
|
+
documd notes.md --format docx # notes.docx
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Diagrams
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
documd flow.puml # flow.svg (PlantUML inferred)
|
|
49
|
+
documd chart.mmd -o chart.png # Mermaid → PNG
|
|
50
|
+
documd flow.puml --format drawio # PlantUML → DrawIO XML
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Supported diagram sources:
|
|
54
|
+
|
|
55
|
+
| Extension | Renderer |
|
|
56
|
+
|---|---|
|
|
57
|
+
| .puml / .plantuml / .wsd | PlantUML (also produces DrawIO XML) |
|
|
58
|
+
| .mmd / .mermaid | Mermaid |
|
|
59
|
+
| .dot / .gv | Graphviz |
|
|
60
|
+
| .vega / .vl | Vega / Vega-Lite |
|
|
61
|
+
| .drawio | DrawIO |
|
|
62
|
+
| .echarts | ECharts |
|
|
63
|
+
| .svg | static SVG (passed through) |
|
|
64
|
+
| .infographic | Infographic |
|
|
65
|
+
| .canvas | Canvas |
|
|
66
|
+
|
|
67
|
+
## Whole books (GitBook SUMMARY.md)
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
documd SUMMARY.md --book # book.epub (default)
|
|
71
|
+
documd SUMMARY.md --book --format docx # merged DOCX
|
|
72
|
+
documd SUMMARY.md --book --format pdf # one page per chapter
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Options
|
|
76
|
+
|
|
77
|
+
| Option | Description |
|
|
78
|
+
|---|---|
|
|
79
|
+
| `-o, --output <file>` | Output path |
|
|
80
|
+
| `--format <f>` | html, epub, docx, pdf, svg, png, drawio |
|
|
81
|
+
| `-b, --book` | Whole-book export (input: GitBook SUMMARY.md) |
|
|
82
|
+
| `--diagram-type <t>` | Diagram renderer override |
|
|
83
|
+
| `-t, --theme <id>` | Viewer theme id |
|
|
84
|
+
| `--title <text>` | Document title |
|
|
85
|
+
| `--language <code>` | Document language |
|
|
86
|
+
| `--frontmatter <mode>` | hide, table, raw |
|
|
87
|
+
| `--table-layout <mode>` | left, center, center-full-width |
|
|
88
|
+
| `--image-layout <mode>` | left, center |
|
|
89
|
+
| `--diagram-layout <mode>` | left, center |
|
|
90
|
+
| `--merge-empty-cells` | Merge empty Markdown table cells |
|
|
91
|
+
| `--chrome <path>` | Explicit Chrome executable path |
|
|
92
|
+
| `--timeout <seconds>` | Render timeout (default 120) |
|
|
93
|
+
| `-h, --help` | Show help |
|
|
94
|
+
|
|
95
|
+
## Notes
|
|
96
|
+
|
|
97
|
+
- Requires Chrome; pass `--chrome` to use a specific binary.
|
|
98
|
+
- Themes, fonts, code highlighting, math and layout settings mirror the
|
|
99
|
+
docu.md Markdown Viewer extension.
|