Kramdown 关键概念

一、kramdown 元素

kramdown元素分为 Block-level ElementsSpan-Level Elements

Block-level Elements 包括

  • Paragraphs
  • Headers
  • Blockquotes
  • Code Blocks
  • Horizontal Rules
  • Lists
  • Definition Lists
  • Tables
  • 其它

Span-Level Elements 包括

  • Emphasis
  • Links and Images
  • Inline Code
  • Footnotes
  • Abbreviations

关于kramdown元素,不必记忆,现用现学,但学的时候要注意以下几点

  1. 元素的表示法

    如Blockquotes的表示是以>开头,后跟一个可选的空格,并且每一行的开头都为>

    而Code Blocks的表示又有两种,一种是 以4个空格 缩进,另一种不用缩进,但是使用 ~~~~ 标志

二、Block-level 元素的结束

当Block-level元素遇到以下时结束。

  1. 空行
  2. EOB字符,a ^ as first character on an otherwise empty line.
  3. 其它(参见官方文档)

三、first character 和 first column

当提交当前Block元素的 first characterfirst column 时,均是指相对于当前元素的嵌套等级来说的,而不是绝对于文档的最左边。

四、缩进与嵌套

即如何利用缩进来嵌套元素。

Block元素中可以包含多个Block元素,这就是嵌套,当然,这种嵌套可以有多层。

可以这样理解,把整个文档想像成一个大的Block元素,这个元素中包含着许许多多的Block元素,拿一个Blockquotes来说,其>必须在第一列上,然后是一个可选的空格,再接非空白字符。这样,一个Block元素就嵌套在文档这个最外层Block元素中了。

此时,再空一行,就可以添加另一个Block元素,如无序列表,只要其*也在第一列上,即Blockquote和List的缩进是相同的,那么,这两个元素就都是外面文档的嵌套元素。

然后就可以引申了,比如要在一个Blockquotes元素中嵌套元素,就可以利用上面的规则来实现。首先要找到Blockquotes元素的第一列是哪一列,然后,其所有要被嵌套的元素都与第一列对齐即可,如嵌套最一个Blockquotes和List, 因为Blockquotes的第一列为其非空白字符所在的那一列,所以只需要将嵌套的Blockquote的>与List的*与该列对齐,两者之间使用空行隔开,就行了。具体的两个更复杂的例子如下:


This is a quote

This is another para.

This is a nested quote.

  1. This is Item 1

  2. This is Item 2.

    This is a code block
    

  1. This is a item 1

  2. This is a item 2

    This is a quoteblock

    another paragraph

    another code block
    

关键点:

找到其直接外层元素的第一列的位置(不同Block元素的第一列位置也不同,可参见文档),然后对齐该位置。

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

推荐阅读更多精彩内容