贡献文档与代码

点击本文右上角的 github 图标，即可查看本工程。在每一页的最下方也有编辑本文的链接，点击即可跳转到 github 编辑。

本书的大纲目录由群主把控，文章内容可自由编辑。本书主线内容以实用为主旨，只提供一条当前较优的、简洁的安装主线。冗余且无意义的内容不被接受。

所有显示或隐式 fork 派生于本项目的副本，应该遵守本项目的许可证协议。任何副本做出的修改不代表其得到了原项目作者的认可。

文档贡献

文档贡献非常简单，你只需要拥有一个编辑器，将工程 fork，修改，提交 pull request 即可。

格式约定

本系列文档的理念是不必过于苛求格式，因为内容才是真正重要的东西。但是也有少量规范必需遵守，否则会影响阅读。

• 使用 OSS code 进行开发，配合 Prettier 插件默认配置进行格式化代码，写完部分文档后使用 ctrl+s 自动格式化保存。
• 每个 md 文档标题按层级编排内容，大标题为#，其次##，再次###，以此类推。
• 代表片段需用 markdown 语法包裹，并指定代码类型，如 bash。
• 一般情况下，请尽量正常使用句号、顿号、引号、冒号等标点符号。
• 需要引起注意的部分可使用 markdown 引用语法。
• 专有名词可使用行内代码``语法进行提示，其比加粗更为明显。
• 行内代码请使用行内代码进行提示。

代码贡献

本工程使用 docsify 编写而成。如果想贡献相关代码请先阅读 docsify 的项目文档。

本工程使用 yarn 管理依赖，结构非常简单。如果没有接触过，你可能需要简单了解一下yarn

本地调试

yarn install
yarn start