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: refs-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 refs-cli
$ refs-cli --watch
$ refs-cli --output website
$ refs-cli
refs-cli@v0.0.1
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"
}
}
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
nilnon分支修改申明
- 支持docs目录下创建多级目录(方便分类),如果不在README.md中定义首页导航,则不渲染到搜索栏中
- 支持在根目录下创建files目录并复制该目录到dist中,方便在mardown中引用文件,如图片和嵌入html文件(markmap脑图等)