文档那么多，该怎么整理

以下内容基本都是通过讯飞语记来实时翻译，再copy后编辑排版，可能存在很多口语话内容，纯属正常现象。

image.png

不管是不是做开发，都遇到很多时候需要做比较，你是怎么样来保存你的笔记资料呢？

做开发其实会涉及到很多的文档的一些编写或整理，比如说，我们启动一个项目要怎么展望目标，然后如何规划一些细节，再然后到项目的分工，项目的产品文档，数据文档，账号平台等资料保存，API文档的说明，系统开发后的操作文档整理等等，对了，还有过程中参考用到的一些资料，学习到的内容的归档等，这些都需要大量的文档保存。

这些所有呢，在最后可能都是通过文档的方式来保存下来才能更方便自己或者给到别人来阅读了解，如果按以前的方式都是通过word文档的方式来处理，那有个也有好也有坏，好处是我可以随时发给别人，但是坏处是有可能在大批量的内容统一做调整或者目录结构发生变化时候，不是很好的去做变更，这样导致内容维护起来没有溯源或者存在很多重复copy。

那有没有一个方式或工具能够满足我们对知识库的管理，这个文档库一直能保持是最新的一个状态，或者说我能随时的追溯到以往的一些记录，能够保证所有的信息都是在最新的，最有用的，而且又是最全面的。
可能很多人会想到或者已经用到例如 印象笔记、有道笔记、熊掌记、Notion 等，的确这些都是非常优秀的工具，但好像又缺了点什么。如果我想我的API文档能本地随时保存好，又能发布到类似这样的平台，又可以单独拿出来整理成API文档手册发布，并且这些操作的切换，其格式还能保存一致，这样对于别的工具来说可能就不一定那么便利了。
这里我介绍一套组合拳 Docsify + Gitee

首先我们要掌握Markdown语法

markdown语言，它的语法是非常的简单，它有统一的标准比类似我们的html这样的一些语法，但是那比html更简单，它主要是针对在内容格式上的一个最简约的维护，能保证我们本地和还是其他支持markdown语法的平台or工具都能统一内容的显示格式

markdown的语法： http://markdown.p2hp.com/basic-syntax/

其次学会用Dosify 来组织文档结构

Docsify 是一个动态生成文档网站的工具,支持本地编辑的内容文档的实时预览

https://docsify.js.org

最后学会用Gitee 保存内容已经发布到Gitee pages以便在线浏览

国内的Git库，保证打开的速度以及能将文档的撰写记录一点一滴都记录下来

http://gitee.com

image.png

logo_gitee_light.png

这样的话，我们自己的知识库就可以开始搭建起来了。
去新建一个git库同步到本地后，新建docs 文件夹，

docsify init ./docs

初始化为docsify的根目录，得到 _sidebar.md 和index.html 文件，分别为菜单目录文件和未来web访问的首页。
可以通过

docsify serve ./docs

来本地预览，对了，编辑的文件工具可以用vscode 或者其他可视化的markdown编写工具。这里边设计到如果要图片上传的话哦，本地保存，发布到线上去可能会导致图片丢失，最好的方式就是图片都是引用外部链接，保持本地和线上体验一致。[todo]这个未来可以展开下图片怎么保存和获取访问地址。

Git库结构

这样我们可以保证内容文档随着开发的进度可以不断修改补充。

`

教你如何使用docsify快速部署优美的在线文档

https://www.cnblogs.com/summerday152/p/14008463.html
`