19.贡献文档与代码

Update date: 2022-07-08

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

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

对于项目资源的添加，如图片，非必要 js 文件，非必要 css 文件等均不被接受。因为某些国家对于 github 的封锁和限制，导致直连下如有此类文件会更大的拖慢网页加载速度。

本项目最初采用 CC BY-SA 4.0 许可，最终改用 CC BY-NC-ND 4.0 许可，原因参见Why we changed the license to CC BY-NC-ND 4.0。

文档贡献
文档贡献非常简单，你只需要拥有一个编辑器，将工程 fork，修改，提交 pull request 即可。注意，如果你提交了一个语言的相关修改，请同时提交另外一种语言对应的修改。

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

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

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

本地调试

yarn install
yarn start