markdown 写技术文档以及左侧树

最新推荐文章于 2025-05-31 12:52:22 发布

原创最新推荐文章于 2025-05-31 12:52:22 发布 · 2k 阅读

CC 4.0 BY-SA版权

本文详细介绍如何使用VSCode及其插件（如markdownpreviewenhanced、markdowntableprettifier和markdownTOC）进行技术文档编写。文章涵盖文档编写流程、依赖插件介绍以及自定义左侧树目录的方法，适合技术文档编写者参考。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

#准备工作
最近准备开始编写技术文档,现在基本上都是开始使用md了,之前使用开源中国的文档编辑来做的,但是最近他的服务关闭了,然后转移到码云的企业版本了,不太想用企业版本服务就想找找其他的,现在使用的是vscode
依赖的插件
markdown previews enhancde 用来预览和生产html
markdown table prettifier 用来格式化biaoge
markdwon toc 用来生产文档 (需要把) file的eol换为\n settings修改
装上这些工具及可以写自己的文档了
#生成左侧树
这个工具真的是不好找,基本上网上都
https://github.com/i5ting
这个哥们五年前写的一套,但是文档有好多不是很好
然后找到了
https://github.com/huyande/MarkdownTemplate
这个几个月前的数据,有了很大的提升,使用之后有bug,并且每次贴进去有点繁琐,我有自己的网站,每次复制进去感觉很麻烦,因为html也是每次都生成的,然后就有了自己改的版本

$(document).ready(function(){
			$(".markdown-body").load("生成的文档",function(){
				$('#tree').ztree_toc({
                is_auto_number:false,
                documment_selector:'.markdown-body',
                is_expand_all: true
            });
			$('#readme').height($('.markdown-preview div').height() + 500);
			setTimeout(function(){
				$('#readme').height($('.markdown-preview div').height() + 500);
			},2000)
			});
        });