feat: add CONTRIBUTING.md document.

wjjwkwindy · Sep 28, 2022 · efa51c0 · efa51c0
1 parent 719da7d
commit efa51c0
Show file tree

Hide file tree

Showing 19 changed files with 573 additions and 214 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,42 @@
+Contributing 贡献
+====
+
+感谢您对**备忘清单**贡献的兴趣👍👍，是像您这样的人使 [`Quick Reference`](https://jaywcjlove.github.io/reference) 成为如此出色的网站 🎉🎉。随时提交问题和增强请求。
+
+`docs/{filename}.md` 文件将被处理成备忘清单，让我们创建或编辑一个 `markdown` 文件：
+
+## 前沿问题
+
+```markdown
+备忘清单 标题
+===
+
+这是您可以在 Quick Reference 备忘清单上使用的样式参考！【备忘清单介绍】
+```
+
+只需要 `标题<h1>` 和`介绍`(标题下面)。脚本会自动识别，通过 GitHub Actions 自动发布 [`Quick Reference`](https://jaywcjlove.github.io/reference) 网站。
+
+## CSS 类注释
+
+[`Quick Reference`](https://jaywcjlove.github.io/reference) 使用 [`@wcj/markdown-to-html`](https://github.com/jaywcjlove/markdown-to-html) 转换 `Markdown`，并使用 [`rehype-attr`](https://github.com/jaywcjlove/rehype-attr) 插件让其支持通过其注释语法添加类和样式。 此外，您可以在 Quick Reference 备忘清单上使用样式参考：https://jaywcjlove.github.io/reference/docs/quickreference.html
+
+最后，参考现有备忘清单的源代码是一个好习惯！
+
+## 首页导航
+
+[`Quick Reference`](https://jaywcjlove.github.io/reference) 的首页存放在仓库的根目录 `README.md`，[`Quick Reference`](https://jaywcjlove.github.io/reference) 是通过这个 `README.md` 自动生成首页导航，下面是导航实例：
+
+```markdown
+## Linux 命令
+
+[Cron](./docs/cron.md)<!--rehype:style=background: rgb(239 68 68/var(\-\-bg\-opacity));-->
+[Git](./docs/git.md)<!--rehype:style=background: rgb(215 89 62/var(\-\-bg\-opacity));-->
+<!--rehype:class=home-card-->
+```
+
+## 本地开发
+
+```bash
+npm i          # 安装依赖
+npm run build  # 编译生成静态页面
+```
diff --git a/docs/cron.md b/docs/cron.md
@@ -36,6 +36,7 @@ Min  Hour Day  Mon  Weekday
 | 月份中的某天   | 1 - 31 | , - * ? / L W      |
 | 月 Month     | 1 - 12 | , - * /            |
 | 星期几        | 0 - 6  | , - * ? / L #      |
+<!--rehype:className=show-header -->
 
 
 ### 示例
@@ -54,7 +55,6 @@ Min  Hour Day  Mon  Weekday
 | `0 0 0 1 * *`  | 每个月的 1 日（每月）   |
 | `0 0 0 1 1 *`  | 每年 1 月 1 日（每年）   |
 | `@reboot`      | 每次重启 _(非标准)_   |
-<!--rehype:class=table-thead-hide-->
 
 
 ### 特殊字符串
@@ -69,6 +69,7 @@ Min  Hour Day  Mon  Weekday
 | @daily         | 每天运行一次，“0 0 * * *” _（非标准）_ |
 | @midnight      | （与@daily 相同）_（非标准）_ |
 | @hourly        | 每小时运行一次，“0 * * * *” _（非标准）_ |
+<!--rehype:className=show-header -->
 
 
 ### Crontab 命令
@@ -80,13 +81,11 @@ Min  Hour Day  Mon  Weekday
 | `crontab -r` | 删除 crontab 文件。 |
 | `crontab -v` | 显示您上次编辑 crontab 文件的时间。 _（非标准）_ |
 | `echo "@reboot echo hi" | crontab` | 轻松添加任务 |
-<!--rehype:class=table-thead-hide-->
 
 
 ### 特殊字符
 <!--rehype:wrap-class=col-span-2-->
 
-<!--rehype:-->
 | 特殊字符             | 说明 |
 |---------------------|------------|
 `星号(*)`  | 匹配字段中的所有值或任何可能的值。
@@ -96,6 +95,7 @@ Min  Hour Day  Mon  Weekday
 `L`       | 仅允许用于 `月份中的某天` 或 `星期几` 字段，`星期几` 中的 `2L` 表示每个月的最后一个星期二
 `井号 (#)` | 仅允许用于 `星期几` 字段，后面必须在 1 到 5 的范围内。例如，`4#1` 表示给定月份的“第一个星期四”。
 `问号(?)`  | 可以代替“*”并允许用于月份和星期几。使用仅限于 cron 表达式中的 `月份中的某天` 或 `星期几`。
+<!--rehype:className=show-header -->
 
 
 ## Also see

diff --git a/docs/docker.md b/docs/docker.md
@@ -51,7 +51,6 @@ $ docker run -it -p 8001:8080 --name my-nginx nginx
 | `docker port <container>`           | 显示容器的端口映射                                  |
 | `docker top <container>`            | 列出进程                                  |
 | `docker kill <container>`           | 杀死一个容器                                  |
-<!--rehype:class=table-thead-hide-->
 
 参数 `<container>` 可以是容器 id 或名称
 
@@ -71,7 +70,6 @@ Docker 容器
 `docker wait nginx-server`    | 阻塞容器
 `docker kill nginx-server`    | 发送 SIGKILL
 `docker attach nginx-server`  | 连接到现有容器
-<!--rehype:class=table-thead-hide-->
 
 ### 说明
 
@@ -86,7 +84,6 @@ Docker 容器
 `docker top nginx-server`     | 运行进程
 `docker stats nginx-server`   | 容器资源使用
 `docker diff nginx-server`    | 列出对容器所做的更改
-<!--rehype:class=table-thead-hide-->
 
 
 ### 创建容器
@@ -131,9 +128,6 @@ docker rm nginx-server
 docker update --cpu-shares 512 -m 300M nginx-server
 ```
 
-
-
-
 Docker Images
 ----
 <!--rehype:body-class=cols-2-->
@@ -151,8 +145,6 @@ Docker Images
 `docker commit nginx`              | 将容器另存为镜像。
 `docker tag nginx eon01/nginx`     | 标记镜像
 `docker push eon01/nginx`          | 推送镜像
-<!--rehype:class=table-thead-hide-->
-
 
 ### 构建镜像
 
@@ -166,8 +158,6 @@ $ docker build -f myOtherDockerfile .
 $ curl example.com/remote/Dockerfile | docker build -f - .
 ```
 
-
-
 Docker 联网
 ----
 <!--rehype:body-class=cols-2-->
@@ -228,9 +218,6 @@ docker network create -d overlay \
   MyOverlayNetwork
 ```
 
-
-
-
 各种各样的
 ----
 <!--rehype:body-class=cols-2-->
@@ -243,7 +230,6 @@ docker network create -d overlay \
 `docker pull user/image   ` | 从 docker hub 下载镜像。
 `docker login             ` | 向 docker hub 进行身份验证
 `docker push user/image   ` | 将镜像上传到 docker hub。
-<!--rehype:class=table-thead-hide-->
 
 ### 注册表命令
 <!--rehype:wrap-class=row-span-3-->
@@ -290,8 +276,6 @@ $ docker push eon01/nginx localhost:5000/myadmin/nginx
 `docker stop -f $(docker ps -a -q)` | 停止所有容器
 `docker rm -f $(docker ps -a -q)` | 删除所有容器
 `docker rmi -f $(docker images -q)` | 删除所有图像
-<!--rehype:class=table-thead-hide-->
-
 
 ### 卷 volume
 

diff --git a/docs/git.md b/docs/git.md
@@ -29,7 +29,6 @@ $ git clone git_url 指定目录
 ### 做出改变
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 在工作目录中**显示**修改后的文件，为您的下一次提交暂存
 
 ```shell
@@ -444,7 +443,6 @@ $ git rm -r --cached <目录/文件>
 ### 修改远程 Commit 记录
 <!--rehype:wrap-class=row-span-4-->
 
-<!--rehype:-->
 ```shell
 $ git rebase -i HEAD~3
 # 表示要修改当前版本的倒数第三次状态

diff --git a/docs/javascript.md b/docs/javascript.md
@@ -129,7 +129,6 @@ let age = 7;
 ### 字符串
 <!--rehype:wrap-class=col-span-2-->
 
-<!--rehype:-->
 ```js
 var abc = "abcdefghijklmnopqrstuvwxyz";
 var esc = 'I don\'t \n know';    // \n 换行
@@ -156,7 +155,6 @@ abc.split("");
 ### 数字
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 ```js
 var pi = 3.141;
 pi.toFixed(0);    // 返回 3             
@@ -213,7 +211,6 @@ Math.floor(Math.random() * 5) + 1;
 ### 全局函数
 <!--rehype:wrap-class=col-span-2-->
 
-<!--rehype:-->
 ```js
 // 像脚本代码一样执行字符串
 eval();                     
@@ -249,7 +246,6 @@ JavaScript 条件
 ### 操作符
 <!--rehype:wrap-class=row-span-3-->
 
-<!--rehype:-->
 ```javascript
 true || false;       // true
 10 > 5 || 10 > 20;   // true
@@ -403,7 +399,6 @@ const rocketToMars = function() {
 ### 箭头函数 (ES6)
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 #### 有两个参数
 
 ```javascript
@@ -496,7 +491,6 @@ JavaScript 范围
 ### 范围
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 ```javascript
 function myFunction() {
   var pizzaName = "Margarita";
@@ -795,7 +789,6 @@ for (let index in fruits) {
 ### label 语句
 <!--rehype:wrap-class= row-span-2-->
 
-<!--rehype:-->
 ```js
 var num = 0;
 
@@ -829,7 +822,6 @@ for (let fruit of fruits) {
 ### for await...of
 <!--rehype:wrap-class= row-span-2-->
 
-<!--rehype:-->
 ```javascript
 async function* asyncGenerator() {
   var i = 0;
@@ -865,7 +857,6 @@ JavaScript 迭代器(Iterators)
 ----
 <!--rehype:body-class=cols-2-->
 
-<!--rehype:-->
 ### 分配给变量的函数
 
 ```javascript
@@ -936,7 +927,6 @@ JavaScript 对象(Objects)
 ----
 <!--rehype:body-class=cols-2-->
 
-<!--rehype:-->
 ### 访问属性
 
 ```javascript
@@ -974,7 +964,6 @@ console.log(classElection.place); // undefined
 ### 可变的
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 ```javascript
 const student = {
   name: 'Sheldon',
@@ -1043,7 +1032,6 @@ console.log(origObj.color);
 ### 工厂函数
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 ```javascript
 // 一个接受 'name'，'age' 和 'breed' 的工厂函数，
 //  参数返回一个自定义的 dog 对象。
@@ -1121,7 +1109,6 @@ JavaScript Classes
 ### 静态方法/字段
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 ```javascript
 class Dog {
   constructor(name) {
@@ -1313,7 +1300,6 @@ JavaScript Promises
 ### Promise
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 创建 promises
 
 ```javascript
@@ -1418,7 +1404,6 @@ promise.catch((err) => {
 ### Promise.all()
 <!--rehype:wrap-class=col-span-2-->
 
-<!--rehype:-->
 ```javascript
 const promise1 = new Promise((resolve, reject) => {
   setTimeout(() => {
@@ -1459,7 +1444,6 @@ promise.then(res => {
 ### 避免嵌套的 Promise 和 .then()
 <!--rehype:wrap-class=col-span-2-->
 
-<!--rehype:-->
 ```javascript
 const promise = new Promise((resolve, reject) => {  
   setTimeout(() => {
@@ -1486,7 +1470,6 @@ JavaScript Async-Await
 ### 异步
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 ```javascript
 function helloWorld() {
   return new Promise(resolve => {
@@ -1613,7 +1596,6 @@ req.send();
 ### POST
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 ```javascript
 const data = { weight: '1.5 KG' };
 const xhr = new XMLHttpRequest();
@@ -1636,7 +1618,6 @@ xhr.onerror = () => {
 ### fetch api
 <!--rehype:wrap-class=row-span-2-->
 
-<!--rehype:-->
 ```javascript
 fetch(url, {
     method: 'POST',
@@ -1697,7 +1678,6 @@ fetch('https://api-xxx.com/endpoint', {
 ### async await 语法
 <!--rehype:wrap-class=col-span-2-->
 
-<!--rehype:-->
 ```javascript
 const getSuggestions = async () => {
   const wordQuery = inputField.value;