- 强烈推荐: 使用 vnote 笔记来进行阅读或编辑,程序员的专属笔记!它的文档体验理论上可以超过IDEA;
- 该文档建议使用IDEA阅读或编辑,以获得更好体验;
- 如果使用IDEA编辑,建议安装
Paste images into MarkDown
插件,可以在编辑时直接将图片粘贴到md文本中; - 文档中对应的图片,建议与文档处于同一级目录,并建立一个
vx_images
文件夹存放; - 如果需要画图,请在其他地方画好之后粘贴进来,尽量控制图片的大小,不要太大;
全使用标准的markdown语法进行编写,参考教程1 参考教程2 。
文件的最顶部尽量添加导航链接,目的是在阅读时能够方便跳转,比如:
主要
[返回首页](../README.md)
---
或
[选项1](../**/**)
[选项2](../**/**)
[返回首页](../**/**/README.md)
---
- 文件夹名和文件名,尽量不要有空格,如需要分隔,统一使用下划线;