最近需要把之前写的代码框架整理成文档,方便程序阅读,以及策划快速上手工具,因为整个框架做成了Unity的PackageManager的插件包,所以最初的想法只是想把内容写到README.md文档中,但在编写的过程中想到内容比较多,就希望md文档可以有类似word文档的左边侧大纲(导航)功能,不过很遗憾的是md虽然可以通过[TOC]生成导航,但是无法做到像word一样显示到左边侧,但是网上有一个思路是把md导出html,然后通过添加css代码来实现这个功能,Typora是一个编写md文档用的工具,它自身拥有像word一样的大纲功能,但是Typora虽然号称目前最好用的md文件编辑工具,但没有像word那样的统治地位,所以无法保证所有用户都安装了这个软件,那边实现侧边导航栏只有导出html文件这一个方法了,毕竟浏览器人人都有。
Typora自身支持带大纲导出html
打开Typora软件,选择文件->偏好设置...->导出->HTML,勾选“保留大纲侧边栏”,然后导出HTML会有左侧导航如下图
从功能上讲,已经满足,不过怎么看都觉太单调~
Typora+VLOOK插件解决方案
简单来说,当md文件转成html文件后,我们可以通过css代码去美化html界面,VLOOK插件做的就是这个事,它默认提供6套免费的主题,增加了很多常用的功能,比如我所需要的侧边导航,并且更丰富,比如支持章节随动,支持搜索,支持图片画中画,支持视频,支持复杂的表格等,更多功能可以参考VLOOK官方文档
下面是同样的md文档通过VLOOK插件生成出来的效果
关于html上传后图片无法显示的解决方案
上传网站时,将xxx.html,改为index.html,将assets文件文件夹上传到index.html的同级目录下
资源下载
Typora v1.2.3(带破解补丁) 链接: https://pan.baidu.com/s/1CamoAK9NARwFOWWGvaCFTg 提取码: encr
VLOOK插件通过上面官网的连接,可以在github或gitee上下载
文章评论