一段JS代码让Markdown自动生成侧边栏目录

不折腾不行小王子今天接到挑战两个问题:markdown怎么定位锚点,怎么生成目录。这其实也是我最近一直在想的,之前看到这样一个项目Gitbook

用github和Markdown写教程书

感觉不错,但是要装node.js,而且写到github上也不安全,公司的东西不能写过去。

锚点

首先,锚点很好解决,比如这里

MarkDown中锚的使用

上文提到的处理方法其实复杂了,简单的其实在mou里就有了介绍:

Anchor
You can also add an anchor for an element such as Headers, then you can link to this anchor anywhere, when you click that link in the Preview view, it'll auto scroll to the place of the destination anchor.
For example below is a normal h2 Header:

This is an example

Now we add an anchor for it, here we use the name "anchor1" for the anchor, of course you can use any name you want.

This is an example

If you want to link to this anchor, simply write like this:
Click this link in the Preview view will auto scroll to the place of the destination anchor.

PS:mou是国人开发的免费markdown编辑器,功能强大。

官网地址:mou

目录

其次是目录,其实搜索“markdown toc”可以看到很多,比如

在markdown插入一段代码就可以生成目录

用法就是把这段代码考到mou里要写的内容前面就好了。如作者所说,mou导出到pdf就不行了。

但是这还是不是我的最终追求。

侧边栏目录

这种侧边栏式的布局最适合写文档看目录用,很快就找到这个

用js实现的侧边栏布局markdown,还能自动编号

这个非常强大了,看截图

image
image

完全实现目标。我为了减少一点复杂程度,剃掉了其他的东西就保留了js,重新弄了一下。

精简版代码

还是需要前后复制粘贴一下就好了。

作者其实给出了更简单的办法,用ruby直接转换,但是我的ruby老是出问题,没弄成。考虑到别人更不一定有ruby,就还是用粘贴的方式吧。

markdown相关

找上面这些内容的时候看到这些资源和文章,也都不错。

关于markdown的进阶

Markdown 语法写作入门指南

关于markdown的css

美化Markdown输出的HTML文档

关于用markdown写幻灯片

Remarkjs: 使用 Markdown 做幻灯

说到幻灯片插播一个

几个秒杀PPT的高(zhe)大(teng)上(ren)的幻灯工具

这是用python写的给markdown生成目录,研究了一下么看懂哈

用 Markdown 来给开源项目写文档

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容