md-lv 1.0.1 → 1.0.2
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 +8 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,12 +19,12 @@ A lightweight local server that renders Markdown files as beautiful HTML pages,
|
|
|
19
19
|
## Installation
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
|
-
npm install -g
|
|
22
|
+
npm install -g md-lv
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
Or use npx:
|
|
26
26
|
```bash
|
|
27
|
-
npx
|
|
27
|
+
npx md-lv
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
## Usage
|
|
@@ -33,16 +33,16 @@ npx markdown-viewer
|
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
35
|
# Serve current directory
|
|
36
|
-
|
|
36
|
+
mdlv
|
|
37
37
|
|
|
38
38
|
# Serve specific directory
|
|
39
|
-
|
|
39
|
+
mdlv --dir /path/to/docs
|
|
40
40
|
|
|
41
41
|
# Serve on custom port
|
|
42
|
-
|
|
42
|
+
mdlv --port 8080
|
|
43
43
|
|
|
44
44
|
# Open README.md automatically
|
|
45
|
-
|
|
45
|
+
mdlv readme
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
### CLI Options
|
|
@@ -58,13 +58,13 @@ mdv readme
|
|
|
58
58
|
|
|
59
59
|
### Subcommands
|
|
60
60
|
|
|
61
|
-
#### `
|
|
61
|
+
#### `mdlv readme`
|
|
62
62
|
|
|
63
63
|
Find and display the nearest README.md file:
|
|
64
64
|
|
|
65
65
|
```bash
|
|
66
66
|
cd /path/to/project
|
|
67
|
-
|
|
67
|
+
mdlv readme
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
This command searches up the directory tree to find README.md and opens it in your browser.
|