markdown-to-html-cli 1.0.5 → 1.0.6
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/.github/workflows/ci.yml +1 -1
- package/README.md +48 -2
- package/lib/index.d.ts +1 -0
- package/lib/index.js +9 -1
- package/lib/index.js.map +1 -1
- package/package.json +3 -3
- package/src/index.ts +14 -1
package/.github/workflows/ci.yml
CHANGED
|
@@ -51,7 +51,7 @@ jobs:
|
|
|
51
51
|
tag: ${{ steps.create_tag.outputs.version }}
|
|
52
52
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
53
53
|
body: |
|
|
54
|
-
[](https://uiwjs.github.io/npm-unpkg/#/pkg/
|
|
54
|
+
[](https://uiwjs.github.io/npm-unpkg/#/pkg/markdown-to-html-cli@${{steps.changelog.outputs.version}}/file/README.md)
|
|
55
55
|
|
|
56
56
|
${{ steps.changelog.outputs.compareurl }}
|
|
57
57
|
|
package/README.md
CHANGED
|
@@ -27,8 +27,12 @@ $ npm i markdown-to-html-cli
|
|
|
27
27
|
```js
|
|
28
28
|
{
|
|
29
29
|
"markdown-to-html": {
|
|
30
|
-
"
|
|
31
|
-
|
|
30
|
+
"document": {
|
|
31
|
+
"title": "markdown-to-html-cli",
|
|
32
|
+
"description": "Command line tool generates markdown as html.",
|
|
33
|
+
"style": "body { color: red; }"
|
|
34
|
+
},
|
|
35
|
+
"github-corners": "https://github.com/jaywcjlove/markdown-to-html-cli",
|
|
32
36
|
"meta": [
|
|
33
37
|
{ "description": "Command line tool generates markdown as html." },
|
|
34
38
|
{ "keywords": "store,localStorage,lightweight,JavaScript" }
|
|
@@ -37,6 +41,10 @@ $ npm i markdown-to-html-cli
|
|
|
37
41
|
}
|
|
38
42
|
```
|
|
39
43
|
|
|
44
|
+
- [`name`](https://github.com/jaywcjlove/markdown-to-html-cli/blob/308ca37aa5b9ae846a7835092a183d0ed73a8dc4/package.json#L2) -> `'markdown-to-html'.title` - The `<title>` tag is required in HTML documents!
|
|
45
|
+
- [`description`](https://github.com/jaywcjlove/markdown-to-html-cli/blob/308ca37aa5b9ae846a7835092a183d0ed73a8dc4/package.json#L4) -> `'markdown-to-html'.description` - Define a description of your web page.
|
|
46
|
+
- [`repository.url`](https://github.com/jaywcjlove/markdown-to-html-cli/blob/308ca37aa5b9ae846a7835092a183d0ed73a8dc4/package.json#L22) -> `'markdown-to-html'.github-corners` - Define a description of your web page.
|
|
47
|
+
|
|
40
48
|
## Command Help
|
|
41
49
|
|
|
42
50
|
```bash
|
|
@@ -65,6 +73,44 @@ Example:
|
|
|
65
73
|
npm markdown-to-html-cli --source README.md
|
|
66
74
|
```
|
|
67
75
|
|
|
76
|
+
## API
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
import { ParsedArgs } from 'minimist';
|
|
80
|
+
import { Options } from 'rehype-document';
|
|
81
|
+
export interface RunArgvs extends ParsedArgs {
|
|
82
|
+
version?: string;
|
|
83
|
+
source?: string;
|
|
84
|
+
output?: string;
|
|
85
|
+
/** Add a Github corner to your project page */
|
|
86
|
+
'github-corners'?: string;
|
|
87
|
+
/** Markdown string. */
|
|
88
|
+
markdown?: string;
|
|
89
|
+
/** The `<title>` tag is required in HTML documents! */
|
|
90
|
+
title?: string;
|
|
91
|
+
/** Define a description of your web page */
|
|
92
|
+
description?: string;
|
|
93
|
+
/** Define keywords for search engines */
|
|
94
|
+
keywords?: string;
|
|
95
|
+
/** Define the author of a page */
|
|
96
|
+
author?: string;
|
|
97
|
+
}
|
|
98
|
+
export interface MDToHTMLOptions {
|
|
99
|
+
'github-corners'?: RunArgvs['github-corners'];
|
|
100
|
+
document?: Options;
|
|
101
|
+
/**
|
|
102
|
+
* rehype-wrap Options
|
|
103
|
+
* Wrap selected elements with a given element
|
|
104
|
+
* https://github.com/mrzmmr/rehype-wrap/tree/2402bcdb8ea25bd0948cda72e96d16e65a18c1e9#options
|
|
105
|
+
*/
|
|
106
|
+
wrap?: {
|
|
107
|
+
selector?: string;
|
|
108
|
+
wrapper?: string;
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
export declare function run(opts?: RunArgvs): any;
|
|
112
|
+
```
|
|
113
|
+
|
|
68
114
|
## Development
|
|
69
115
|
|
|
70
116
|
```bash
|
package/lib/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -41,14 +41,22 @@ export function run(opts = {}) {
|
|
|
41
41
|
if (pgkData.name && !options.document.title) {
|
|
42
42
|
options.document.title = pgkData.name;
|
|
43
43
|
}
|
|
44
|
+
if (pgkData.repository && !argvs['github-corners']) {
|
|
45
|
+
argvs['github-corners'] = typeof pgkData.repository === 'string' ? pgkData.repository : pgkData.repository.url;
|
|
46
|
+
}
|
|
44
47
|
if (pgkData['markdown-to-html']) {
|
|
45
48
|
mth = pgkData['markdown-to-html'];
|
|
46
|
-
|
|
49
|
+
const { title, meta } = options.document;
|
|
50
|
+
options.document = { title, meta, ...mth.document };
|
|
51
|
+
if (mth.document.title) {
|
|
47
52
|
options.document.title = mth.document.title;
|
|
48
53
|
}
|
|
49
54
|
if (!options.wrap) {
|
|
50
55
|
options.wrap = mth.wrap;
|
|
51
56
|
}
|
|
57
|
+
if (!argvs['github-corners'] && mth['github-corners']) {
|
|
58
|
+
argvs['github-corners'] = mth['github-corners'];
|
|
59
|
+
}
|
|
52
60
|
}
|
|
53
61
|
}
|
|
54
62
|
if (Array.isArray(options.document.meta)) {
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,QAAwB,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,QAAwB,MAAM,UAAU,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;AAkC3E,MAAM,UAAU,GAAG,CAAC,OAAO,EAAc;IACvC,MAAM,KAAK,GAAa,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACtD,KAAK,EAAE;YACL,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,GAAG;YACZ,MAAM,EAAE,GAAG;YACX,MAAM,EAAE,GAAG;SACZ;QACD,OAAO,EAAE;YACP,OAAO,EAAE,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,IAAI,KAAK;YACxC,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,IAAI,KAAK;YAClC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,WAAW;YAC5C,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,EAAE;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE;YACnC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,YAAY;SAC9C;KACF,CAAC,CAAC;IACH,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,EAAE;QACzB,OAAO,EAAE,CAAC;QACV,WAAW,EAAE,CAAC;QACd,OAAO;KACR;IACD,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE;QAC5B,OAAO,CAAC,GAAG,CAAC,2CAA2C,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC;QACxE,OAAO,GAAG,CAAC,OAAO,CAAC;KACpB;IACD,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;QACnC,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;KACzE;IACD,MAAM,OAAO,GAAoB,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC;IAChF,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;IAE/D,IAAI,OAAO,GAAQ,EAAE,CAAC;IACtB,IAAI,GAAG,GAAoB,EAAE,CAAA;IAC7B,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;QAC7B,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACtC,IAAI,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE;YAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;SACvC;QACD,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE;YAClD,KAAK,CAAC,gBAAgB,CAAC,GAAG,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAA;SAC/G;QACD,IAAI,OAAO,CAAC,kBAAkB,CAAC,EAAE;YAC/B,GAAG,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;YAElC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;YACzC,OAAO,CAAC,QAAQ,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;YAEpD,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE;gBACtB,OAAO,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC;aAC7C;YAED,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;gBACjB,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;aACzB;YAED,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,gBAAgB,CAAC,EAAE;gBACrD,KAAK,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAC,gBAAgB,CAAC,CAAC;aACjD;SACF;KACF;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACxC,IAAI,KAAK,CAAC,WAAW,EAAE;YACrB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;SAChE;aAAM,IAAI,OAAO,CAAC,WAAW,EAAE;YAC9B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;SAClE;QACD,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;SAC1D;aAAM,IAAI,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC9D,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACtE;QACD,IAAI,KAAK,CAAC,MAAM,EAAE;YAChB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;SACtD;KACF;IACD,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE;QACrC,OAAO,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;KAC3C;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC3C,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACtC,OAAO,CAAC,GAAG,CAAC,iCAAiC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;AAChG,CAAC;AAED,MAAM,UAAU,OAAO;IACrB,OAAO,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAC;IAChE,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC9B,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,qBAAqB,CAAC,CAAC;IAC7D,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,4BAA4B,CAAC,CAAC;IACpE,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,iDAAiD,EAAE,qBAAqB,CAAC,CAAC;IAChH,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,0CAA0C,EAAE,oBAAoB,CAAC,CAAC;IACxG,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAAC;IAC1D,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,wCAAwC,CAAC,CAAC;IAChF,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,qCAAqC,CAAC,CAAC;IAC7E,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,kDAAkD,CAAC,CAAC;IAC1F,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,8BAA8B,CAAC,CAAC;IACtE,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,4CAA4C,CAAC,CAAC;IACpF,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,2CAA2C,CAAC,CAAC;AACrF,CAAC;AAED,MAAM,UAAU,WAAW;IACzB,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC9B,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;IAC3D,OAAO,CAAC,GAAG,CAAC,sFAAsF,CAAC,CAAC;IACpG,OAAO,CAAC,GAAG,CAAC,gIAAgI,CAAC,CAAC;IAC9I,OAAO,CAAC,GAAG,CAAC,yFAAyF,CAAC,CAAC;IACvG,OAAO,CAAC,GAAG,CAAC,+EAA+E,CAAC,CAAC;IAC7F,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "markdown-to-html-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.6",
|
|
4
4
|
"description": "Command line tool generates markdown as html.",
|
|
5
5
|
"homepage": "https://jaywcjlove.github.io/markdown-to-html-cli/",
|
|
6
6
|
"exports": "./lib/index.js",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
},
|
|
11
11
|
"type": "module",
|
|
12
12
|
"scripts": {
|
|
13
|
-
"start": "node lib/cli.js
|
|
13
|
+
"start": "node lib/cli.js",
|
|
14
14
|
"watch": "tsbb watch --disable-babel --file-names src/cli.ts",
|
|
15
15
|
"build": "tsbb build --disable-babel --file-names src/cli.ts && npm run fix",
|
|
16
16
|
"fix": "tsc-esm-fix --target='lib' --ext='.js'",
|
|
@@ -59,6 +59,6 @@
|
|
|
59
59
|
"minimist": "1.2.5"
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
|
62
|
-
"tsbb": "3.3.
|
|
62
|
+
"tsbb": "3.3.7"
|
|
63
63
|
}
|
|
64
64
|
}
|
package/src/index.ts
CHANGED
|
@@ -25,6 +25,7 @@ export interface RunArgvs extends ParsedArgs {
|
|
|
25
25
|
}
|
|
26
26
|
|
|
27
27
|
export interface MDToHTMLOptions {
|
|
28
|
+
'github-corners'?: RunArgvs['github-corners'];
|
|
28
29
|
document?: Options
|
|
29
30
|
/**
|
|
30
31
|
* rehype-wrap Options
|
|
@@ -76,14 +77,26 @@ export function run(opts = {} as RunArgvs) {
|
|
|
76
77
|
if (pgkData.name && !options.document.title) {
|
|
77
78
|
options.document.title = pgkData.name;
|
|
78
79
|
}
|
|
80
|
+
if (pgkData.repository && !argvs['github-corners']) {
|
|
81
|
+
argvs['github-corners'] = typeof pgkData.repository === 'string' ? pgkData.repository : pgkData.repository.url
|
|
82
|
+
}
|
|
79
83
|
if (pgkData['markdown-to-html']) {
|
|
80
84
|
mth = pgkData['markdown-to-html'];
|
|
81
|
-
|
|
85
|
+
|
|
86
|
+
const { title, meta } = options.document;
|
|
87
|
+
options.document = { title, meta, ...mth.document };
|
|
88
|
+
|
|
89
|
+
if (mth.document.title) {
|
|
82
90
|
options.document.title = mth.document.title;
|
|
83
91
|
}
|
|
92
|
+
|
|
84
93
|
if (!options.wrap) {
|
|
85
94
|
options.wrap = mth.wrap;
|
|
86
95
|
}
|
|
96
|
+
|
|
97
|
+
if (!argvs['github-corners'] && mth['github-corners']) {
|
|
98
|
+
argvs['github-corners'] = mth['github-corners'];
|
|
99
|
+
}
|
|
87
100
|
}
|
|
88
101
|
}
|
|
89
102
|
|