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` 来完成。推荐使用后者,预览效果相对丰富一些;

---
......

生成格式

markdown生成目录_第1张图片
image.png

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

markdown生成目录_第2张图片
image.png

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


          
                  
            #{ff.gsub('.md','')}
                    #{css_link}
                  
          
          
                  
#{parse_markdown}

你可能感兴趣的:(markdown生成目录)