@shunyasasaki/mkserve 0.1.1 → 0.1.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 +14 -28
- package/dist/cli.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
|
|
5
|
+
|
|
5
6
|
|
|
6
7
|
|
|
7
8
|
Serve a folder of Markdown files as a live-reloading preview site: a file tree
|
|
@@ -9,46 +10,33 @@ on the left, the rendered document on the right, refreshed every time you save.
|
|
|
9
10
|
|
|
10
11
|
## ⚡ Quick Start
|
|
11
12
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
@shunya-sasaki:registry=https://npm.pkg.github.com
|
|
17
|
-
//npm.pkg.github.com/:_authToken=${GH_TOKEN}
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
2. Install and run:
|
|
21
|
-
|
|
22
|
-
```sh
|
|
23
|
-
pnpm add -g @shunya-sasaki/mkserve
|
|
24
|
-
mkserve --open # serve the current directory and open the browser
|
|
25
|
-
```
|
|
13
|
+
```sh
|
|
14
|
+
pnpm add -g @shunyasasaki/mkserve
|
|
15
|
+
mkserve --open # serve the current directory and open the browser
|
|
16
|
+
```
|
|
26
17
|
|
|
27
18
|
Open any `.md` file in your editor, save it, and the page updates in place.
|
|
28
19
|
|
|
29
20
|
## 📦 Requirements
|
|
30
21
|
|
|
31
22
|
- Node.js 20.19 or later
|
|
32
|
-
- A GitHub token with the `read:packages` scope (GitHub Packages requires
|
|
33
|
-
authentication even for public packages)
|
|
34
23
|
|
|
35
24
|
## ⚙️ Setup
|
|
36
25
|
|
|
37
|
-
`mkserve` is published
|
|
38
|
-
|
|
26
|
+
`mkserve` is published on [npm](https://www.npmjs.com/package/@shunyasasaki/mkserve).
|
|
27
|
+
Install it globally with your preferred tool:
|
|
39
28
|
|
|
40
|
-
```
|
|
41
|
-
@
|
|
42
|
-
|
|
29
|
+
```sh
|
|
30
|
+
pnpm add -g @shunyasasaki/mkserve # pnpm
|
|
31
|
+
npm install -g @shunyasasaki/mkserve # npm
|
|
32
|
+
mise use -g npm:@shunyasasaki/mkserve # mise
|
|
43
33
|
```
|
|
44
34
|
|
|
45
|
-
|
|
46
|
-
directly. Then install with your preferred tool:
|
|
35
|
+
Or run it once without installing:
|
|
47
36
|
|
|
48
37
|
```sh
|
|
49
|
-
pnpm
|
|
50
|
-
|
|
51
|
-
pnpm dlx @shunya-sasaki/mkserve # run once without installing
|
|
38
|
+
pnpm dlx @shunyasasaki/mkserve
|
|
39
|
+
npx @shunyasasaki/mkserve
|
|
52
40
|
```
|
|
53
41
|
|
|
54
42
|
## 🚀 Usage
|
|
@@ -106,8 +94,6 @@ Stop the server with `Ctrl+C`.
|
|
|
106
94
|
the sidebar edge to resize it.
|
|
107
95
|
- Light and dark themes follow your system setting.
|
|
108
96
|
|
|
109
|
-
## 📚 Reference
|
|
110
|
-
|
|
111
97
|
## 📄 License
|
|
112
98
|
|
|
113
99
|
MIT
|
package/dist/cli.mjs
CHANGED
|
@@ -28,7 +28,7 @@ import { visit } from "unist-util-visit";
|
|
|
28
28
|
import { watch } from "chokidar";
|
|
29
29
|
import ignore from "ignore";
|
|
30
30
|
//#region package.json
|
|
31
|
-
var version = "0.1.
|
|
31
|
+
var version = "0.1.2";
|
|
32
32
|
var description = "Serve a workspace of Markdown files with a live-reloading preview.";
|
|
33
33
|
//#endregion
|
|
34
34
|
//#region src/shared/paths.ts
|