@dhruv2mars/mdv 0.0.6 → 0.0.8
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 +39 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# @dhruv2mars/mdv
|
|
2
|
+
|
|
3
|
+
Fast terminal markdown viewer/editor.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i -g @dhruv2mars/mdv
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
First run downloads native `mdv` binary.
|
|
12
|
+
Assets are resolved from GitHub Releases for your platform/arch.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
mdv README.md
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Stream stdin:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
tail -f notes.md | mdv --stream
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Keybinds
|
|
27
|
+
|
|
28
|
+
- `Ctrl+Q` quit
|
|
29
|
+
- `Ctrl+S` save
|
|
30
|
+
- `Ctrl+R` reload
|
|
31
|
+
- `Ctrl+K` keep local on conflict
|
|
32
|
+
- `Ctrl+M` merge markers on conflict
|
|
33
|
+
|
|
34
|
+
## Flags
|
|
35
|
+
|
|
36
|
+
- `--readonly` disable editing
|
|
37
|
+
- `--no-watch` disable file watch
|
|
38
|
+
- `--stream` read markdown from stdin
|
|
39
|
+
- `--perf` show perf stats
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dhruv2mars/mdv",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.8",
|
|
4
4
|
"description": "Terminal-first markdown visualizer/editor",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -14,7 +14,8 @@
|
|
|
14
14
|
"postinstall": "node bin/install.js",
|
|
15
15
|
"selftest": "node bin/selftest.js",
|
|
16
16
|
"lint": "node --check bin/mdv.js && node --check bin/install.js && node --check bin/install-lib.js && node --check bin/selftest.js",
|
|
17
|
-
"test": "node scripts/test.js"
|
|
17
|
+
"test": "node scripts/test.js",
|
|
18
|
+
"coverage": "c8 --all --include bin/install-lib.js --reporter text-summary --check-coverage --lines 100 --functions 100 --branches 80 --statements 100 node scripts/test.js"
|
|
18
19
|
},
|
|
19
20
|
"keywords": [
|
|
20
21
|
"markdown",
|