markdown生成目录

markdown生成目录步骤

安装

gem install tocmd
当前安装版本0.4.3

生成HTML文件

  • 指定单个文件
    tocmd -f ***.md
  • 指定目录
    tocmd -d .

markdown

# markdown自动目录

## 使用说明

### 前期工作

1. 一款好用的文本编辑器,用来编辑html文档。推荐使用sublime text;

2. 你的markdown文件中必须存在目录结构,即不同级别的标题。

3. 把你的markdown文件转化成html,这一步可以使用sublime text的插件 `Markdown Preview` 或 `OmniMarkupPreviewer` 来完成。推荐使用后者,预览效果相对丰富一些;

---

## 使用说明

### 前期工作

1. 一款好用的文本编辑器,用来编辑html文档。推荐使用sublime text;

2. 你的markdown文件中必须存在目录结构,即不同级别的标题。

3. 把你的markdown文件转化成html,这一步可以使用sublime text的插件 `Markdown Preview` 或 `OmniMarkupPreviewer` 来完成。推荐使用后者,预览效果相对丰富一些;

---
......

生成格式

image.png

备注:
如遇到样式有问题的情况,找到tocmd-0.4.3/lib/tocmd/目录下以translator开头的三个文件进行更改即可

image.png

其中样式部分(更改后的)

<html>
          <head>
                  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
            <title>#{ff.gsub('.md','')}</title>
                    #{css_link}
                  <style>
                    .ztree li a.curSelectedNode {
                        padding-top: 0px;
                        background-color: #FFE6B0;
                        color: black;
                        height: 16px;
                        border: 1px #FFB951 solid;
                        opacity: 0.8;
                    }
                    .ztree{
                        overflow: auto;
                        height:100%;
                        min-height: 200px;
                        top: 0px;
                    }
                    pre {
                        counter-reset: line-numbering;
                        border: solid 1px #d9d9d9;
                        border-radius: 0;
                        background: #fff;
                        padding: 0;
                        line-height: 23px;
                        margin-bottom: 30px;
                        white-space: pre;
                        overflow-x: auto;
                        word-break: inherit;
                        word-wrap: inherit;
                    }

                    pre a::before {
                      content: counter(line-numbering);
                      counter-increment: line-numbering;
                      padding-right: 1em; /* space after numbers */
                      width: 25px;
                      text-align: right;
                      opacity: 0.7;
                      display: inline-block;
                      color: #aaa;
                      background: #eee;
                      margin-right: 16px;
                      padding: 2px 10px;
                      font-size: 13px;
                      -webkit-touch-callout: none;
                      -webkit-user-select: none;
                      -khtml-user-select: none;
                      -moz-user-select: none;
                      -ms-user-select: none;
                      user-select: none;
                    }

                    pre a:first-of-type::before {
                      padding-top: 10px;
                    }

                    pre a:last-of-type::before {
                      padding-bottom: 10px;
                    }

                    pre a:only-of-type::before {
                      padding: 10px;
                    }
            
                    .highlight { background-color: #ffffcc } /* RIGHT */
                    </style>
          </head>
          <body>
                  <div>
                            <div style='width:25%;'>
                                    <ul id="tree" class="ztree" style='width:100%'>
        
                                    </ul>
                            </div>
                    <div id='readme' style='width:70%;margin-left:25%;'>
                        <article class='markdown-body'>
                            #{parse_markdown}
                        </article>
                    </div>
                    </div>
          </body>
        </html>
            <script type="text/javascript" src="#{@editor_path}/toc/js/jquery-1.4.4.min.js"></script>
            <script type="text/javascript" src="#{@editor_path}/toc/js/jquery.ztree.all-3.5.min.js"></script>
            <script type="text/javascript" src="#{@editor_path}/toc/js/ztree_toc.js"></script>
            <SCRIPT type="text/javascript" >
            <!--
            $(document).ready(function(){
                $('#tree').ztree_toc({
                    is_auto_number:true,
                    documment_selector:'.markdown-body'
                });
            });
            //-->
            </SCRIPT>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,600评论 18 139
  • Ubuntu的发音 Ubuntu,源于非洲祖鲁人和科萨人的语言,发作 oo-boon-too 的音。了解发音是有意...
    萤火虫de梦阅读 99,159评论 9 467
  • linux资料总章2.1 1.0写的不好抱歉 但是2.0已经改了很多 但是错误还是无法避免 以后资料会慢慢更新 大...
    数据革命阅读 12,135评论 2 34
  • CocoaPods 是什么? CocoaPods 是一个负责管理 iOS 项目中第三方开源库的工具。CocoaPo...
    朝洋阅读 25,637评论 3 51
  • 2016年11月12日(天气预报:阵雨) 天公很作美,大家顺利到达了目的地 来到了大山深处,远离了喧嚣, 青山绿水...
    Q琳阅读 489评论 0 0