md-card-cli

一个将markdown转换为卡片式html页面的命令行工具。

Document

中文文档
英文文档
test

Example Show

科目一
科目二
科目三
科目四
科目五
科目六
科目七
科目八
科目九
我是科目十

Command Help

1Usage: md-card-cli [output-dir] [--help|h]
2
3  Displays help information.
4
5Options:
6
7  --version, -v   Show version number
8  --help, -h      Displays help information.
9  --watch, -w     Watch and compile Markdown files.
10  --output, -o    Output directory. defalut(dist)
11  --force, -f     Force file regeneration.
12
13Example:
14
15  $ npx md-card-cli
16  $ md-card-cli --watch
17  $ md-card-cli --output website
18  $ md-card-cli
19
20md-card-cli@v0.0.1

Config

Store .refsrc.json in the root directory of the project

1{
2  "title": "md-card-cli",
3  "description": "{{description}}. A command line tool to convert markdown to a card-html page !",
4  "keywords": "reference-cli,reference,md-card-cli,html-cli,cli",
5  "data-info": "👆click me !",
6  "search": {
7    "label": "Search",
8    "placeholder": "Search for card",
9    "cancel": "Cancel"
10  },
11  "network": {
12    "label": "Blog",
13    "url": "site",
14    "disabled": false
15  },
16  "github": {
17    "url": "https://github.com/ytanck/md-card-cli"
18  },
19  "home": {
20    "label": "Home",
21    "url": "https://ytanck.github.io/md-card-cli"
22  },
23  "giscus": {
24    "src": "https://giscus.app/client.js",
25    "data-repo": "ytanck/md-card-cli",
26    "data-repo-id": "R_kgDOLb0Dow",
27    "data-category": "Q&A",
28    "data-category-id": "DIC_kwDOLb0Do84CdwWy",
29    "data-mapping": "pathname",
30    "data-strict": "0",
31    "data-reactions-enabled": "1",
32    "data-emit-metadata": "0",
33    "data-input-position": "bottom",
34    "data-theme": "preferred_color_scheme",
35    "data-lang": "zh-CN",
36    "crossorigin": "anonymous",
37    "async": true
38  }
39}

Support adding giscus comments.

Support JSON, JSONC, JSON5, YAML, TOML, INI, CJS, Typescript, and ESM config load.

TOML config example:

1title = "md-card-cli"
2description = "{{description}}. A command line tool to convert markdown to a card-html page !"
3keywords = "reference-cli,reference,md-card-cli,refs,cli"
4data-info = "👆click me"
5[search]
6  label = "Search"
7  placeholder = "Search for content"
8  cancel = "Cancel"
9
10[network]
11  label = "Blog"
12  url = "site"
13  disabled = false
14[github]
15  url = "https://github.com/ytanck/md-card-cli"
16[home]
17  label = "Home"
18  url = "https://ytanck.github.io/md-card-cli"

Support for more config loading.

1.refsrc                    .refsrc.json
2.refsrc.json5              .refsrc.jsonc
3.refsrc.yaml               .refsrc.yml
4.refsrc.toml               .refsrc.ini
5.refsrc.js                 .refsrc.ts
6.refsrc.cjs                .refsrc.mjs
7.config/refsrc             .config/refsrc.json
8.config/refsrc.json5       .config/refsrc.jsonc
9.config/refsrc.yaml        .config/refsrc.yml
10.config/refsrc.toml        .config/refsrc.ini
11.config/refsrc.js          .config/refsrc.ts
12.config/refsrc.cjs         .config/refsrc.mjs
13refs.config.js             refs.config.ts
14refs.config.cjs            refs.config.mjs

友情链接

baidu.com github youtube gitee

License

MIT © ytanck