diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69e56f6..b50287c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,26 @@ Contributing 贡献 只需要 `标题

` 和`介绍`(标题下面)。脚本会自动识别,通过 GitHub Actions 自动发布 [`Quick Reference`](https://jaywcjlove.github.io/reference) 网站。 +## 目录结构 + +```bash +. +├── CONTRIBUTING.md # 贡献说明 +├── Dockerfile +├── LICENSE +├── README.md # Home(首页) 内容 +├── dist # 编译后的静态资源目录 +├── docs # Markdown 文档(快速参考备忘清单【速查表】) +│   ├── bash.md +│   ├── .... +│   └── yaml.md +├── package.json +└── scripts # MD 转 HTML 的编译脚本 + ├── assets + ├── .... + └── watch.mjs +``` + ## 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