最近在做组内的文档建设,团队之前大部分都是用wiki记录,wiki对外的话经常涉及权限问题,另外,wiki的风格和UI整体效果感觉不是很清晰也不够美观。所以,这次打算用Markdown来做文档建设工作。
相关资料:
1、markdown编辑器介绍
几款主流好用的markdown编辑器介绍_黄志千的博客-CSDN博客_markdown编辑器
2、markdown教程
3、官方文档:
编辑器我最终使用的是Typora,Typora编辑markdown特别好用,可设置源码模式,或者直接展示样式,两种模式编辑。
Typora还可以将markdown导出成PDF,html等。
其中导出成PDF格式,可设置按照一级标题分页。
文档建设补充资料:
1、中文技术文档写作规范(阮一峰):GitHub - ruanyf/document-style-guide: 中文技术文档的写作规范
2、AppleDoc文档:https://github.com/tomaz/appledoc