idea 使用markdown总结

逃离我推掉我的手 2023-06-09 10:11 22阅读 0赞

### 文章目录 ###

*  背景
 *   *  博客管理文档
     *  用github管理文档
     *   *  缺点
     *  用github+csdn管理
     *  word对于简单文档来说不适用，同时版本对比也麻烦。
 *  idea 使用markdown插件
 *   *  问题
     *  解决对策
 *  参考资料

# 背景 #

## 博客管理文档 ##

公司要做文档管理，之前的想法是每个人写博客。

*  但是出现问题交集的时候，就无法有效的更新内容了，每天我还得汇总他们的资料，麻烦(内容不同步问题)
 *  同时，我总结的时候，都是写的链接加引用备注，这样的形式导致文档特别分散
 *  同时csdn的一些博客没有历史版本记录，简书虽然有但是我是重来不会给历史加备注。

## 用github管理文档 ##

*  优点就是解决上面的问题。
 *  csdn还支持github的博客搬家，多么好

### 缺点 ###

*  github 天然不支持生成目录(但是有插件)
 *  纯的markdown语法没有标签管理。
 *  纯的markdown语法对图片的引用不是特别好。

## 用github+csdn管理 ##

*  csdn做标签管理，+ github的链接地址。
 *  同时也可以给我们的github项目引流
 *  完美，只不过用户需要跳转2次页面。

## word对于简单文档来说不适用，同时版本对比也麻烦。 ##

# idea 使用markdown插件 #

## 问题 ##

*  支持github原生显示问题
 *  图片复制问题
 *  目录问题
 *  同屏幕滚动

## 解决对策 ##

*  [在IntelliJ中添加MarkDown编辑插件][IntelliJ_MarkDown]
    
     *  [支持Github样式的预览][Github]
     *  [破解 Markdown Navigator–2.7.0][Markdown Navigator_2.7.0]

> 支持Github样式的预览

*  [IntelliJ IDEA markDown文件上传截图][IntelliJ IDEA markDown]

> 安装 Paste images into MarkDown 插件

*  [markdown 文件生成 toc 目录][markdown _ toc]

> Markdown-toc 可以用来生成 markdown 页面的目录，便于 github 页面展现。  
> 这里不能直接使用它的jar，必须先把项目down下来再使用。

# 参考资料 #

*  [推荐IntelliJ IDEA下Markdown插件idea-multimarkdown][IntelliJ IDEA_Markdown_idea-multimarkdown]

> 如果仅需要Github样式的预览，则有gfm-plugin插件支持，原汁原味。

*  [markdown 文本内跳转,生成目录][markdown]
 *  [自动生成GFM目录][GFM]
 *  百度: github markdown 生成目录 – 为github markdown 文件生成目录(toc) - 叶止水 - CSDN博客

[IntelliJ_MarkDown]: https://blog.csdn.net/weixin_36570478/article/details/82733479
[Github]: http://plugins.jetbrains.com/plugin/7896-markdown-navigator
[Markdown Navigator_2.7.0]: https://github.com/CrazyBunQnQ/multimarkdown
[IntelliJ IDEA markDown]: https://www.jianshu.com/p/499c48f5de22
[markdown _ toc]: https://github.com/houbb/markdown-toc#maven
[IntelliJ IDEA_Markdown_idea-multimarkdown]: http://www.cuiguojie.com/blog/idea-multimarkdown
[markdown]: https://blog.csdn.net/dss_dssssd/article/details/82959037
[GFM]: https://blog.csdn.net/qq_41562433/article/details/82995273