快速开始
欢迎参与PotatoVN的文档维护!
文档是用户了解和使用产品的第一步。加入我们,帮助完善文档。无论是添加新的内容,还是更新现有信息,您的贡献都是极其宝贵的。
PotatoVN的文档是基于Markdown编写的,使用VuePress生成。
- 如果您不熟悉Markdown,可以5分钟内快速入门,戳我阅读Markdown教程
- 如果您了解Markdown,也推荐您快速浏览上述教程并注意其中的本站编写注意事项。
PotatoVN的文档支持多种编辑方式,您可以选择适合自己的方式进行编辑。
简单编写单页文档
综合评价
难度:⭐️
适合:在线快速编辑某篇已存在文档的内容
需要技能:markdown基础
缺点:无法添加或删除新的文档,只能编辑已存在的文档
使用本方式编辑文档可以直接在每篇文档的末尾点击“编辑此页面”链接,然后在弹出的链接中在线调整并预览效果。
请参阅教程查看操作步骤。
使用在线编辑器编写文档
综合评价
难度:⭐️⭐️
适合: 在线编辑多篇文档,新增/删除文档,无需本地环境
需要技能:markdown基础
缺点:对电脑性能略微有要求,对于“不如丢到ho里”的机器可能会有卡顿
请参阅教程查看操作步骤。
本地环境编写文档
综合评价
难度:⭐️⭐️⭐️
适合:对文档有较大改动,甚至可以新增vue组件来实现更复杂的功能
需要技能:markdown基础,vue基础, git基础
缺点:需要本地环境