欢迎!非常感谢您对本项目有兴趣。
在编辑前,请阅读以下介绍。
本文提供项目的基本信息。
编辑指导在《贡献指南》。详细的写作风格要求在《写作风格指南》。也可直接访问 docs
目录,探索其他指南。
当准备就绪后,请 fork 此 repo。如果已经持有老旧的 fork,不妨采用您习惯的方式更新。之后开始编辑。最后新建一个 pull request。
感谢您的支持。
下述规则已写入 .editorconfig
。
可以在 EditorConfig.org 了解该文件的有关知识。
未说明的项目暂不做要求。
摘要如下
元素 | 风格 |
---|---|
标题 (heading) | ATX heading |
强调与加粗 (emphasis) | * |
无序列表 (unordered list) | * |
分割线 (thematic break) | --- |
代码块 (fenced code block) | ``` |
删除线 (strikethrough) | <del></del> |
键盘输入 (keyboard input) | <kbd></kbd> |
注意
- 在多级列表中,子级的左端应当对齐父级的内容的左端。详见 CommonMark Spec 的 “5.2 List items” 的第 6 条。
- 磁力链接 (magnet) 请以 code block 呈现,以防编译错误。
- 请使用
<del>
添加删除线。不要使用<strike>
,因为该元素已经废除。- 请不要触动 front matter,除非本项目的管理者 @TieBaMma 已经确认需要修改。
- 随着 GitHub Pages 上部署的 Jekyll 更新换代,可以使用的 Markdown 语法或许会有扩展。参看 Markdown processor for your GitHub Pages site。
详细的写作风格要求在《写作风格指南》。
摘要如下
尽管我们对编辑工具没有要求,您甚至可以直接使用 GitHub 网页内置的文本编辑器工作;但仍然建议使用功能丰富且正确支持 CommonMark 的编辑器以减少编辑错误。
尚无想法?不妨尝试这几款编辑器和插件。
请阅读《贡献指南》。
如果需要了解 Jekyll 文件的意义,请访问它的文档。
以下仅列出关键文件。
对象 | 说明 |
---|---|
.github/ |
GitHub 配置 |
.vscode/ |
VS Code settings |
docs/ |
贡献指南 |
_config.yml |
Jekyll 配置 |
index.md |
文章主页 |
本项目使用 Jekyll,由 GitHub Pages 自动生成网站。
本项目使用 Jason Long 制作的 Cayman theme,基于 pietromenna/jekyll-cayman-theme@595426b,修改了部分样式。
本项目使用 Vladimir Jimenez 制作的 allejo/jekyll-toc@204bd5c 来生成 Table of Contents。