@mryhryki/markdown-preview 0.5.1 → 0.5.3

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 CHANGED
@@ -4,7 +4,7 @@ Markdown realtime preview on browser with your favorite editor.
4
4
 
5
5
  ## Demo
6
6
 
7
- ![DEMO](https://github.com/mryhryki/markdown-preview/assets/12733897/68cb3653-254b-4540-9859-0a7c262736e0)
7
+ https://github.com/mryhryki/markdown-preview/assets/12733897/86d27eaa-8b69-48a4-82a5-04f5602925f6
8
8
 
9
9
  ## Usage
10
10
 
@@ -26,11 +26,11 @@ $ npm install -g @mryhryki/markdown-preview
26
26
  # or
27
27
  $ yarn install -g @mryhryki/markdown-preview
28
28
 
29
- $ markdown-preview --file README.md --template default --port 34567 --log-level info --no-opener
29
+ $ markdown-preview --file README.md --template default-dark --port 34567 --log-level info --no-opener
30
30
  Root Directory : /current/dir
31
31
  Default File : README.md
32
32
  Extensions : md, markdown
33
- Template File : /path/to/template/default.html
33
+ Template File : /path/to/template/default-dark.html
34
34
  Preview URL : http://localhost:34567
35
35
  ```
36
36
 
@@ -77,3 +77,29 @@ Sample code is presented below.
77
77
  </body>
78
78
  </html>
79
79
  ```
80
+
81
+ ## Development
82
+
83
+ ```shell
84
+ $ npm install
85
+
86
+ # Watch mode
87
+ $ npm run dev
88
+
89
+ # Build and Run
90
+ $ npm start
91
+
92
+ # Test
93
+ $ npm test
94
+ $ npm run test:watch
95
+
96
+ # Type check
97
+ $ npm run type
98
+ $ npm run type:watch
99
+
100
+ # Check code format
101
+ $ npm run lint
102
+
103
+ # Formatter
104
+ $ npm run fmt
105
+ ```
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@mryhryki/markdown-preview",
3
3
  "description": "Markdown realtime preview on browser",
4
- "version": "0.5.1",
4
+ "version": "0.5.3",
5
5
  "author": "mryhryki",
6
6
  "license": "MIT",
7
7
  "publishConfig": {
@@ -58,8 +58,8 @@
58
58
  "scripts": {
59
59
  "build": "tsc",
60
60
  "dev": "nodemon --watch ./src/ --ext 'ts' --exec 'npm start -- --no-opener --log-level debug'",
61
- "lint": "eslint ./src/",
62
- "lint:fix": "eslint ./src/ --fix",
61
+ "fmt": "prettier --write ./src/**/*.ts ./**/*.html && eslint ./src/**/*.ts --fix",
62
+ "lint": "prettier --check ./src/**/*.ts ./**/*.html && eslint ./src/**/*.ts",
63
63
  "release": "npm run build && npm publish",
64
64
  "start": "npm run build && node ./index.js",
65
65
  "test": "jest",