markmap-cli 0.16.0 → 0.16.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 +2 -53
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -6,57 +6,6 @@
|
|
|
6
6
|
|
|
7
7
|
Use [markmap-lib](https://markmap.js.org/) in command-line.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Usage
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
$ yarn global add markmap-cli
|
|
13
|
-
# or
|
|
14
|
-
$ npm install -g markmap-cli
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
You can also use with `npx` without installation:
|
|
18
|
-
|
|
19
|
-
```sh
|
|
20
|
-
$ npx markmap-cli
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Command-line Usage
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
Usage: markmap [options] <input>
|
|
27
|
-
|
|
28
|
-
Create a markmap from a Markdown input file
|
|
29
|
-
|
|
30
|
-
Options:
|
|
31
|
-
-V, --version output the version number
|
|
32
|
-
--no-open do not open the output file after generation
|
|
33
|
-
--no-toolbar do not show toolbar
|
|
34
|
-
-o, --output <output> specify filename of the output HTML
|
|
35
|
-
-w, --watch watch the input file and update output on the fly, note that this feature is for development only
|
|
36
|
-
-h, --help display help for command
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
### Creating a markmap
|
|
40
|
-
|
|
41
|
-
Suppose we have a Markdown file named `note.md`.
|
|
42
|
-
|
|
43
|
-
Run the following command to get an interactive mindmap:
|
|
44
|
-
|
|
45
|
-
```sh
|
|
46
|
-
$ markmap note.md
|
|
47
|
-
|
|
48
|
-
# without global installation
|
|
49
|
-
$ npx markmap-lib note.md
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Then we get `note.html` in the same directory, and hopefully it will be open in your default browser.
|
|
53
|
-
|
|
54
|
-
### Watching changes
|
|
55
|
-
|
|
56
|
-
Enable watching mode by `-w`:
|
|
57
|
-
|
|
58
|
-
```sh
|
|
59
|
-
$ markmap -w note.md
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
A markmap will be created and opened in your browser, and will be updated as soon as changes are saved to the source file.
|
|
11
|
+
See [the documentation](https://markmap.js.org/docs/packages--markmap-cli).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "markmap-cli",
|
|
3
|
-
"version": "0.16.
|
|
3
|
+
"version": "0.16.1",
|
|
4
4
|
"description": "Create markmaps from CLI",
|
|
5
5
|
"author": "Gerald <gera2ld@live.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"commander": "^11.1.0",
|
|
50
50
|
"hono": "^3.11.8",
|
|
51
51
|
"markmap-common": "0.16.0",
|
|
52
|
-
"markmap-lib": "0.16.
|
|
52
|
+
"markmap-lib": "0.16.1",
|
|
53
53
|
"markmap-render": "0.16.0",
|
|
54
54
|
"markmap-toolbar": "0.16.0",
|
|
55
55
|
"open": "^10.0.0",
|
|
@@ -57,5 +57,5 @@
|
|
|
57
57
|
"read-package-up": "^11.0.0",
|
|
58
58
|
"update-notifier": "^7.0.0"
|
|
59
59
|
},
|
|
60
|
-
"gitHead": "
|
|
60
|
+
"gitHead": "f10ad62ef03e02a1843484cca51521f48989fab7"
|
|
61
61
|
}
|