Refs CLI

Command line tool to generate Quick Reference website. This is also a tool separated from Quick Reference to help Quick Reference compile and generate HTML websites

Document

Reference English
Reference 中文

Example Show

Bash
C
C#
C++
Dart
Docker
Dockerfile
Django
Flutter
Golang

Command Help

Usage: huid-reference-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 huid-reference-cli
  $ huid-reference-cli --watch
  $ huid-reference-cli --output website
  $ huid-reference-cli

[email protected]

Config

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

{
  "title": "Refs CLI",
  "description": "{{description}}. Sharing Quick Reference Cheat Sheets for Developers",
  "keywords": "reference-cli,reference,refs-cli,refs,cli",
  "data-info": "👆👆need your participation",
  "search": {
    "label": "Search",
    "placeholder": "Search for cheatsheet",
    "cancel": "Cancel"
  },
  "editor": {
    "label": "Edit"
  },
  "github": {
    "url": "https://github.com/jaywcjlove/refs-cli"
  },
  "home": {
    "label": "Home",
    "url": "https://jaywcjlove.github.io/refs-cli"
  },
  "giscus": {
    "src": "https://giscus.app/client.js",
    "data-repo": "jaywcjlove/refs-cli",
    "data-repo-id": "R_kgDOIfibtA",
    "data-category": "Q&A",
    "data-category-id": "DIC_kwDOIfibtM4CZObA",
    "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": "en",
    "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 = "Refs CLI"
description = "{{description}}. Sharing Quick Reference Cheat Sheets for Developers"
keywords = "reference-cli,reference,refs-cli,refs,cli"
data-info = "👆👆need your participation"
[search]
  label = "Search"
  placeholder = "Search for cheatsheet"
  cancel = "Cancel"

[editor]
  label = "Edit"
[github]
  url = "https://github.com/jaywcjlove/refs-cli"
[home]
  label = "Home"
  url = "https://jaywcjlove.github.io/refs-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

Thanks to all contributors

See Quick Reference for how to get started. As always, thanks to our amazing contributors!

List of contributors, automatically generated by contributors

Mirror site of Quick Reference

quickref.cn ecdata.cn aibk.cn jgeek.cn laoleng.vip liujiapeng.com dbyun.net dc6.fun if010.com pipecraft.net isteed.cc 1han.wiki linzhe.top xushanxiang.com winnerzr01.github.io isteed.cc hestudio.org surcode.cn hestudio.org cms.im nuomiphp.com eryajf.net kjchmc.cn

License

MIT © Kenny Wong