@dhruv2mars/mdv 0.0.6 → 0.0.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 +38 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
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
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
mdv README.md
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Stream stdin:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
tail -f notes.md | mdv --stream
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Keybinds
|
|
26
|
+
|
|
27
|
+
- `Ctrl+Q` quit
|
|
28
|
+
- `Ctrl+S` save
|
|
29
|
+
- `Ctrl+R` reload
|
|
30
|
+
- `Ctrl+K` keep local on conflict
|
|
31
|
+
- `Ctrl+M` merge markers on conflict
|
|
32
|
+
|
|
33
|
+
## Flags
|
|
34
|
+
|
|
35
|
+
- `--readonly` disable editing
|
|
36
|
+
- `--no-watch` disable file watch
|
|
37
|
+
- `--stream` read markdown from stdin
|
|
38
|
+
- `--perf` show perf stats
|