Skip to main content

小书匠语法说明之定义

小书匠语法说明之定义相关疑问使用HTML效果示例概述

概述

定义语法不是标准的 commonmark, 不同的编辑器或者博客平台支持可能不一样。小书匠使用 markdown-it 的扩展 markdown-it-deflist 实现对定义的支持。

该语法格式也是主要参考了 pandoc 的定义格式

使用

元数据标识: grammar_deflist

想要使用该语法,需要在设置>扩展语法 里把定义选项打开。或者在每篇文章的元数据里通过 grammar_deflist 进行控制。系统默认打开定义语法功能

语法结构

  1. 1Term 1 
  2. 2 
  3. 3: Definition 1 
  4. 4 
  5. 5Term 2 with *inline markup* 
  6. 6 
  7. 7: Definition 2 
  8. 8 
  9. 9 { some code, part of Definition 2 } 
  10. 10 
  11. 11 Third paragraph of definition 2. 

或者

  1. 1Term 1 
  2. 2 ~ Definition 1 
  3. 3 
  4. 4Term 2 
  5. 5 ~ Definition 2a 
  6. 6 ~ Definition 2b 

示例

  1. 1苹果 
  2. 2: 一种水果 
  3. 3: 一种品牌,计算机,手持设备 
  4. 4桔子 
  5. 5: 一种水果 

效果

苹果
一种水果
一种品牌,计算机,手持设备
桔子
一种水果

HTML

生成 的 html 片段

  1. 1<dl> 
  2. 2<dt>苹果</dt> 
  3. 3<dd>一种水果</dd> 
  4. 4<dd>一种品牌,计算机,手持设备</dd> 
  5. 5<dt>桔子</dt> 
  6. 6<dd>一种水果</dd> 
  7. 7</dl> 

疑问

相关

  1. markdown-it github官网
  2. markdown-it 语法测试
  3. pandoc def list