背景
博客管理文档
公司要做文档管理,之前的想法是每个人写博客。
- 但是出现问题交集的时候,就无法有效的更新内容了,每天我还得汇总他们的资料,麻烦(内容不同步问题)
- 同时,我总结的时候,都是写的链接加引用备注,这样的形式导致文档特别分散
- 同时csdn的一些博客没有历史版本记录,简书虽然有但是我是重来不会给历史加备注。
用github管理文档
- 优点就是解决上面的问题。
- csdn还支持github的博客搬家,多么好
缺点
- github 天然不支持生成目录(但是有插件)
- 纯的markdown语法没有标签管理。
- 纯的markdown语法对图片的引用不是特别好。
用github+csdn管理
- csdn做标签管理,+ github的链接地址。
- 同时也可以给我们的github项目引流
- 完美,只不过用户需要跳转2次页面。
word对于简单文档来说不适用,同时版本对比也麻烦。
idea 使用markdown插件
问题
- 支持github原生显示问题
- 图片复制问题
- 目录问题
- 同屏幕滚动
解决对策
支持Github样式的预览
安装 Paste images into MarkDown 插件
Markdown-toc 可以用来生成 markdown 页面的目录,便于 github 页面展现。
这里不能直接使用它的jar,必须先把项目down下来再使用。
参考资料
如果仅需要Github样式的预览,则有gfm-plugin插件支持,原汁原味。