i5ting_toc工具使用,markdown转html,目录在左侧,一键将md转html自动发布网页

本文档详细介绍了如何使用i5ting_toc工具将Markdown文件转换为HTML,并展示如何修改模板以实现代码高亮。通过修改marked.js和template.html文件,将目录放在左侧,以及引入code-prettify库,实现了更友好的阅读体验。同时,文章还涵盖了插件的安装、使用方法以及高级配置步骤。
摘要由CSDN通过智能技术生成

markdown转html工具i5ting_toc安装

背景

使用 Markdown 编辑器写完产品的使用手册后,导出为 html文件,目录是用 toc 生成的,显示在html页面的最上方。因为使用手册的内容很多,需要将目录栏放至左侧方便跳转目录阅览,于是就不用 toc 生成,采取另外的方法。

插件介绍

这里使用的是Github上的一个JQuery插件,插件功能是 用于将markdown 转化为带样式的html字符串,正好有我们需要的左侧目录栏样式,于是采用了这个插件。

Github项目地址:node版本i5ting_toc

环境安装

依赖于node.js 故需要先安装node.js ,安装方法请自行百度

在这里插入图片描述

安装插件

使用下面命令进行全局安装:

npm install -g i5ting_toc

插件用法

安装好 i5ting_toc 后,就可以使用简单的命令了。比如输入i5ting_toc -h查看插件用法,如下图示:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Fxkrxotc-1625960385922)(assets/image-20210711071542821.png)]

md 文件转 html 文件

  • 进入md文件所在目录,打开cmd窗口
  • 输入命令i5ting_toc -f index.md -o

命令执行完后,md文件目录下生成了一个preview文件夹,我们需要的html文件夹就在里面,然后直接浏览器打开这个html即可。如下图示:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-451QCHOO-1625960385924)(assets/image-20210711072010415.png)][外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-UcefnWKM-1625960385926)(assets/image-20210711072020898.png
在这里插入图片描述

转换后的样式,目录在左边,方便阅读

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-83PHy26F-1625960385927)(assets/image-20210711072047287.png)]

i5ting_toc转成的html,怎么高亮代码

找到安装位置

全局安装一般在默认位置
C:\Users\administrator\AppData\Roaming\npm\node_modules\i5ting_toc

修改marked.js

i5ting_toc\node_modules\marked\lib\marked.js
将第804行添加class样式

class="prettyprint linenums:0"

修改后如下:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1rbq8ccy-1625960385928)(assets/image-20210711072557941.png)]

修改templete.html

i5ting_toc\vendor\template.html
引入google的高亮插件code-prettify

将 run_prettify.js 下载到本地,地址如下:
https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js

修改后如下:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-0JbYMbUH-1625960385929)(assets/image-20210711072741690.png)]

需要删除已经生成的preview文件夹

否则有可能不生效

再执行编译html命令

i5ting_toc -f index.md -o

修改前后对比

  • 修改前:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-InTj0Awp-1625960385930)(assets/image-20210711073304325.png)]

  • 修改后:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-sV4zRVhr-1625960385931)(assets/image-20210711073128694.png)]

i5ting_toc高级配置

找到 i5ting_toc 插件安装目标

  • 安装目标:

C:\Users\administrator\AppData\Roaming\npm\node_modules\i5ting_toc

  • 修改样式

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-niJm4HlM-1625960385932)(assets/image-20210711073619317.png)]

  • 修改方式

利用i5ting_toc -f index.md -o 命令生成html后,采用浏览器F12 Debug调试相应样式

  • 2
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

时间辜负了谁

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值