MarkDown生成目录索引

144
作者 10H3Y
2015.12.17 14:16* 字数 590

今天新项目有开始整理接口文档,以前用Page写 发现Page在写完后插入内容的时候有可能把内容挤丢 今天准备用MackDown试试 为了方便别人阅读找了好多文章才找到这个生成目录索引的方法

效果图如下


2222.png

安装Package Control

安装包控制扩展可以方便地为st添加拓展。
打开st,按下组合键Control + `,出现控制台,输入

import urllib2,os; pf='Package Control.sublime-package'; ipp = sublime.installed_packages_path(); os.makedirs( ipp ) if not os.path.exists(ipp) else None; urllib2.install_opener( urllib2.build_opener( urllib2.ProxyHandler( ))); open( os.path.join( ipp, pf), 'wb' ).write( urllib2.urlopen( 'http://sublime.wbond.net/' +pf.replace( ' ','%20' )).read()); print( 'Please restart Sublime Text to finish installation')

当看到代码最后一行提示的时候说明安装成功,此时重启st,可在Preferences -> Package Settings看到Package Control。

安装markdown preview

按下键Ctrl+Shift+p调出命令面板,找到Package Control: install Pakage这一项。搜索markdown preview,点击安装。

使用

Markdown Preview较常用的功能是preview in browser和Export HTML in Sublime Text,前者可以在浏览器看到预览效果,后者可将markdown保存为html文件。

preview in browser据称是实时的,但是实践上还是需要在st保存,然后浏览器刷新才能看到新的效果,好在markdown写得多的话也不需要每敲一行看一次效果。

快捷键

st支持自定义快捷键,markdown preview默认没有快捷键,我们可以自己为preview in browser设置快捷键。方法是在Preferences -> Key Bindings User打开的文件的中括号中添加以下代码(可在Key Bindings Default找到格式):

{ "keys": ["alt+m"], "command": "markdown_preview", "args": { "target": "browser"} }

"alt+m"可设置为自己喜欢的按键。
设置语法高亮和mathjax支持
在Preferences ->Package Settings->Markdown Preview->Setting Default中的第31行和36行找到

/*
       Enable or not mathjax support.
    */
    "enable_mathjax": false,

    /*
        Enable or not highlight.js support for syntax highlighting.
    */
    "enable_highlight": false,

将 两个false改为true即可。
语法高亮跟编辑器的主题有关,可以在Preferences ->Color Scheme找自己喜欢的主题。
关于目录生成,只要文章是按照markdown语法写作的。在需要生成目录的地方写
[TOC]
即可。

直接参考这篇文章了
https://segmentfault.com/q/1010000000468575
http://www.jianshu.com/p/378338f10263

iOS