pandoc 使用教程

pandoc

md转html命令

pandoc -s -S --toc -c github2.css 电子投屏前端项目文档.md  -o 电子投屏前端项目文档.html   

生成幻灯片

  1. 下载FORMAT( Slidy|Slideous| revealjs|S5)放在 .md 文件根目录
  2. pandoc -t FORMAT -s habits.txt -o habits.html //相对文件路径
  3. pandoc -t FORMAT -s habits.txt -o habits.html –self-contained //加—self-contained 参数 依赖內联
  4. pandoc mockserver.md -o mockserver.html -t revealjs -s --self-contained

转换输出PDF幻灯片格式的文件:(中文可能乱码)
pandoc -t beamer habits.md -o habits.pdf

幻灯结构:
slide level : 页面组织结构中,紧接着文章内容的最高header等级

幻灯页划分规则:

  1. 水平线分页
  2. header等级===slide level

幻灯片的结构化
slide level: 默认情况下,slide level由文章的组织结构中,以紧接着文章内容(而不是另一个标题)的最高的header等级决定。在上面的例子中,一级标题总是紧跟着二级标题,二级标题后会跟着实际内容,因此slide level是2。这由文章组织结构内容决定的slide level可由pandoc 的 –slide-level选项覆盖。
文章内容根据以下规则划分为不同的幻灯片页:

  • 一条水平线总会开启一页新幻灯片。
  • header等级等于slide level总会开启一页新的幻灯片。
  • 组织结构中在slide level以下的headers会在同一幻灯片页中创建headers。例如上述例子slide level等于2,那么如果有H3或者H4等级的headers,那么它们会显示在由其他规则创建的幻灯片页中。
  • 组织结构中在slide level以上的headers会创建“title slides”,它只包含了该section的标题,从而将整个幻灯片的内容划分为不同的sections。
  • pandoc会自动根据文中的title block创建出一页title page。当然,必须得存在title block。
    如果你不是很在意将幻灯片划分为多个sections和subsections的话,那么你可以在所有的幻灯片页中只使用一级标题(这样的话,slide level等于1),当然你也可以像上述示例一样将其划分为不同的sections。
    Note: 在reveal.js类型的幻灯片中,如果slide level等于2,那么产生的幻灯片会是一个二维的布局,一级标题会产生水平控制阅读的幻灯片,二级标题会产生垂直方向控制的幻灯片。另外,不建议使用reveal.js写slide level大于2的幻灯片内容。
    增量式列表
    默认情况下,pandoc转换输出的列表都是一次性显示出来。你可以在转换输出幻灯片时使用-i选项使列表一次只显示一个列表项。如果你想让某一个特定的列表显示与默认的不一样,也就是: 没有使用-i选项的时候使某一列表增量显示,或者,使用-i选项的时候使某一列表一次性显示出来,你可以将该特定列表放置于block quote中, 如下所示:
    1 2 > - Eat spaghetti > - Drink wine
    插入停顿
    你可以在幻灯片页中添加停顿,该功能通过在幻灯片页中插入包含3个点的段落实现,且该三个点间以空格隔开,如下所示:
    1 2 3 4 5 6 7 # Slide with a pause
    content before the pause
    . . .
    content after the pause
    定义幻灯片样式
    你可以通过将自定义CSS文件放置于用户数据目录(DATADIR下来改变HTML的样式,对于S5而言,该目录是)DATADIR/s5/default; Slidy: (DATADIR/slidy;Slideous:)DATADIR/slideous; $DATADIR指的是数据目录,参考–data-dir选项说明。
    对于reveal.js,幻灯片主题可通过设置theme变量指定,如下所示:
    -V theme=moon
    或者可以通过–css选项指定自定义的CSS样式表.
    定义beamer幻灯片的样式时,可使用-V选项,指定其“theme”或者“colortheme”:
    pandoc -t beamer habits.md -V theme:Warsaw -o habits.pdf
    Note: pandoc在转换输出为HTML格式的幻灯片时,header的属性值会变为幻灯片页的属性(在
    或者
    标签中),这样就可以通过css自定义单一的幻灯片页的样式了。如下:

References {.allowframebreaks}

转化HTML slide shows常用参数

  • -s, –standalone转换输出文档时会自动加上合适的header和footer(例如standalone HTML, LaTeX, RTF).该选择在转换输出pdf,epub,epub3,fb2,docx,odt格式文件时会被自动设置,因此如果转换输出上述格式文件,则不用显示指定该选项。如上所述,使用该选项后,能够将所有依赖的文件(linked scripts,stylesheets, images, and videos)都转换输出到同一个文件中。
  • –slide-level=NUMBER指定能够创建新幻灯片页的headers等级(对beamer, s5, slidy, slideous, dzslides而言)。在设定的level以上的header将幻灯片划分为不同的sections,在level以下的headers在同一页幻灯片中创建子标题.默认情况下根据文档内容自动确定,见幻灯片的结构化.
  • -i, –incremental使幻灯片中的列表选项增量式显示(one by one)。默认情况下,列表内容会一次性显示出来。
  • -c URL, –css=URL链接到CSS样式表。该选项能够使用多次来引入多个文件,所指定的文件能够以指定的顺序依次引入。
  • –data-dir=DIRECTORY指定用户数据目录,设定之后会在该目录下搜索pandoc数据文件。如果没有指定该选项,则会使用默认的用户数据目录:$HOME/.pandoc可通过pandoc --version命令查看。
  • –base-header-level=NUMBER指定headers的基准level,默认是1.
  • –section-divs将sections包裹进标签(在HTML5中包裹进标签),并且将header的identifiers附属到或者标签中。详见Section identifiers.
  • Math rendering in HTML如果文档中包含有TeX math,则需要看上述链接的中的内容.

eg:

% Habits
% John Doe
% March 22, 2005

# In the morning

## Getting up

- Turn off alarm
- Get out of bed

## Breakfast

- Eat eggs
- Drink coffee

------------------

![UML attribute text](http://readus-org.qiniudn.com/img/uml-class-diagram/attribute-text.png)

## Going to sleep

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

推荐阅读更多精彩内容