1.用邮箱注册个账号并登录
3.编辑你的项目基本信息,主要包括:
- 产品的名字,比如VuePress
- 产品简易描述
- 产品的宣传标语
- 产品的特点特色
- 项目编译后会自动生成如下的首页信息(这里以maptalks产品举例)
4.接着点击项目的文档按钮,为你的项目添加菜单,目录结构,文档等了
- 添加菜单
- 为每个菜单添加对应的目录结构和文档内容
- 编辑每个文档的内容
- 上传已经存在的markdown文件
- 保存你编辑好的文档
- ...
- 仅仅支持二级目录,如果你文档有多级目录的需求,应该尽可能的将其平行话,不要进行嵌套,技术上支持多级目录没有问题,但是生成的侧边栏会非常丑陋
- 比如有个需求是要展示:中国->省->市这样的需求,你可以改成中国-江苏,中国-上海这样的结构目录
- 多人协作一个项目时要尽可能的按照菜单和功能的划分来协作文档的书写,比如人员1负责菜单1,人员2负责菜单2这样来安排任务,尽可能的减少多人同时操作同一个文档的可能,以此来减少文档的冲突
5.当你认为文档写的差不多了,你就可以编译你的项目了,然后点击浏览地址就可以查看你的项目文档的内容了