md-card-cli

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

Document

中文文档
英文文档
test

Example Show

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

Command Help

Usage: md-card-cli [output-dir] [--help|h]

  Displays help information.

Options:

  --version, -v   Show version number
  --help, -h      Displays help information.
  --watch, -w     Watch and compile Markdown files.
  --output, -o    Output directory. defalut(dist)
  --force, -f     Force file regeneration.

Example:

  $ npx md-card-cli
  $ md-card-cli --watch
  $ md-card-cli --output website
  $ md-card-cli

[email protected]

Config

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

{
  "title": "md-card-cli",
  "description": "{{description}}. A command line tool to convert markdown to a card-html page !",
  "keywords": "reference-cli,reference,md-card-cli,html-cli,cli",
  "data-info": "👆click me !",
  "search": {
    "label": "Search",
    "placeholder": "Search for card",
    "cancel": "Cancel"
  },
  "network": {
    "label": "Blog",
    "url": "site",
    "disabled": false
  },
  "github": {
    "url": "https://github.com/ytanck/md-card-cli"
  },
  "home": {
    "label": "Home",
    "url": "https://ytanck.github.io/md-card-cli"
  },
  "giscus": {
    "src": "https://giscus.app/client.js",
    "data-repo": "ytanck/md-card-cli",
    "data-repo-id": "R_kgDOLb0Dow",
    "data-category": "Q&A",
    "data-category-id": "DIC_kwDOLb0Do84CdwWy",
    "data-mapping": "pathname",
    "data-strict": "0",
    "data-reactions-enabled": "1",
    "data-emit-metadata": "0",
    "data-input-position": "bottom",
    "data-theme": "preferred_color_scheme",
    "data-lang": "zh-CN",
    "crossorigin": "anonymous",
    "async": true
  }
}

Support adding giscus comments.

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

TOML config example:

title = "md-card-cli"
description = "{{description}}. A command line tool to convert markdown to a card-html page !"
keywords = "reference-cli,reference,md-card-cli,refs,cli"
data-info = "👆click me"
[search]
  label = "Search"
  placeholder = "Search for content"
  cancel = "Cancel"

[network]
  label = "Blog"
  url = "site"
  disabled = false
[github]
  url = "https://github.com/ytanck/md-card-cli"
[home]
  label = "Home"
  url = "https://ytanck.github.io/md-card-cli"

Support for more config loading.

.refsrc                    .refsrc.json
.refsrc.json5              .refsrc.jsonc
.refsrc.yaml               .refsrc.yml
.refsrc.toml               .refsrc.ini
.refsrc.js                 .refsrc.ts
.refsrc.cjs                .refsrc.mjs
.config/refsrc             .config/refsrc.json
.config/refsrc.json5       .config/refsrc.jsonc
.config/refsrc.yaml        .config/refsrc.yml
.config/refsrc.toml        .config/refsrc.ini
.config/refsrc.js          .config/refsrc.ts
.config/refsrc.cjs         .config/refsrc.mjs
refs.config.js             refs.config.ts
refs.config.cjs            refs.config.mjs

友情链接

baidu.com github youtube gitee

License

MIT © ytanck