markdown生成目錄

markdown生成目錄步驟

安裝

gem install tocmd
當(dāng)前安裝版本0.4.3

生成HTML文件

  • 指定單個文件
    tocmd -f ***.md
  • 指定目錄
    tocmd -d .

markdown

# markdown自動目錄

## 使用說明

### 前期工作

1. 一款好用的文本編輯器跛溉,用來編輯html文檔焊切。推薦使用sublime text;

2. 你的markdown文件中必須存在目錄結(jié)構(gòu)芳室,即不同級別的標(biāo)題专肪。

3. 把你的markdown文件轉(zhuǎn)化成html,這一步可以使用sublime text的插件 `Markdown Preview` 或 `OmniMarkupPreviewer` 來完成堪侯。推薦使用后者嚎尤,預(yù)覽效果相對豐富一些;

---

## 使用說明

### 前期工作

1. 一款好用的文本編輯器抖格,用來編輯html文檔诺苹。推薦使用sublime text咕晋;

2. 你的markdown文件中必須存在目錄結(jié)構(gòu),即不同級別的標(biāo)題收奔。

3. 把你的markdown文件轉(zhuǎn)化成html掌呜,這一步可以使用sublime text的插件 `Markdown Preview` 或 `OmniMarkupPreviewer` 來完成。推薦使用后者坪哄,預(yù)覽效果相對豐富一些质蕉;

---
......

生成格式

image.png

備注:
如遇到樣式有問題的情況,找到tocmd-0.4.3/lib/tocmd/目錄下以translator開頭的三個文件進(jìn)行更改即可

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>
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末翩肌,一起剝皮案震驚了整個濱河市模暗,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌念祭,老刑警劉巖兑宇,帶你破解...
    沈念sama閱讀 218,036評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異粱坤,居然都是意外死亡隶糕,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,046評論 3 395
  • 文/潘曉璐 我一進(jìn)店門站玄,熙熙樓的掌柜王于貴愁眉苦臉地迎上來枚驻,“玉大人,你說我怎么就攤上這事株旷≡俚牵” “怎么了?”我有些...
    開封第一講書人閱讀 164,411評論 0 354
  • 文/不壞的土叔 我叫張陵晾剖,是天一觀的道長锉矢。 經(jīng)常有香客問我,道長钞瀑,這世上最難降的妖魔是什么沈撞? 我笑而不...
    開封第一講書人閱讀 58,622評論 1 293
  • 正文 為了忘掉前任慷荔,我火速辦了婚禮雕什,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘显晶。我一直安慰自己贷岸,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,661評論 6 392
  • 文/花漫 我一把揭開白布磷雇。 她就那樣靜靜地躺著偿警,像睡著了一般。 火紅的嫁衣襯著肌膚如雪唯笙。 梳的紋絲不亂的頭發(fā)上螟蒸,一...
    開封第一講書人閱讀 51,521評論 1 304
  • 那天盒使,我揣著相機(jī)與錄音,去河邊找鬼七嫌。 笑死少办,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的诵原。 我是一名探鬼主播英妓,決...
    沈念sama閱讀 40,288評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼绍赛!你這毒婦竟也來了蔓纠?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,200評論 0 276
  • 序言:老撾萬榮一對情侶失蹤吗蚌,失蹤者是張志新(化名)和其女友劉穎腿倚,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體蚯妇,經(jīng)...
    沈念sama閱讀 45,644評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡猴誊,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,837評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了侮措。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片懈叹。...
    茶點故事閱讀 39,953評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖分扎,靈堂內(nèi)的尸體忽然破棺而出澄成,到底是詐尸還是另有隱情,我是刑警寧澤畏吓,帶...
    沈念sama閱讀 35,673評論 5 346
  • 正文 年R本政府宣布墨状,位于F島的核電站,受9級特大地震影響菲饼,放射性物質(zhì)發(fā)生泄漏肾砂。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,281評論 3 329
  • 文/蒙蒙 一宏悦、第九天 我趴在偏房一處隱蔽的房頂上張望镐确。 院中可真熱鬧,春花似錦饼煞、人聲如沸源葫。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,889評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽息堂。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間荣堰,已是汗流浹背床未。 一陣腳步聲響...
    開封第一講書人閱讀 33,011評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留振坚,地道東北人即硼。 一個月前我還...
    沈念sama閱讀 48,119評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像屡拨,于是被迫代替她去往敵國和親只酥。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,901評論 2 355

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理呀狼,服務(wù)發(fā)現(xiàn)裂允,斷路器,智...
    卡卡羅2017閱讀 134,656評論 18 139
  • Ubuntu的發(fā)音 Ubuntu十饥,源于非洲祖魯人和科薩人的語言,發(fā)作 oo-boon-too 的音祖乳。了解發(fā)音是有意...
    螢火蟲de夢閱讀 99,269評論 9 467
  • linux資料總章2.1 1.0寫的不好抱歉 但是2.0已經(jīng)改了很多 但是錯誤還是無法避免 以后資料會慢慢更新 大...
    數(shù)據(jù)革命閱讀 12,167評論 2 33
  • CocoaPods 是什么逗堵? CocoaPods 是一個負(fù)責(zé)管理 iOS 項目中第三方開源庫的工具。CocoaPo...
    朝洋閱讀 25,679評論 3 51
  • 2016年11月12日(天氣預(yù)報:陣雨) 天公很作美眷昆,大家順利到達(dá)了目的地 來到了大山深處蜒秤,遠(yuǎn)離了喧囂, 青山綠水...
    Q琳閱讀 504評論 0 0