本文阅读量 次
1. 备注信息块¶
1.1 备注信息¶
1.1.1 支持类型¶
MkDoc Material 支持如下几种类型的备注信息
- note
- abstract
- info
- tip
- success
- question
- warning
- failure
- danger
- bug
- example
- quote
1.1.2 基本语法¶
!!! note "这是 title"
这是 `note` 示例
这是 title
这是 note 示例
1.1.3 各 类型 效果如下¶
Note
这是 note 示例
Abstract
这是 abstract 示例
Info
这是 info 示例
Tip
这是 tip 示例
Success
这是 success 示例
Question
这是 question 示例
Warning
这是 warning 示例
Failure
这是 failure 示例
Danger
这是 danger 示例
Bug
这是 bug 示例
Example
这是 example 示例
Quote
这是 quote 示例
1.1.4 基础用法之上的变化¶
1.1.4.1 指定标题¶
!!! note "这里是标题"
可以 `note` 之后通过 `引号` 指定标题的
这里是标题
可以 note 之后通过 引号 指定标题的
1.1.4.2 去掉标题¶
!!! note ""
可以 `note` 之后通过 `引号` 为空 **去掉** 标题
可以 note 之后通过 引号 为空 去掉 标题
1.1.4.3 缩放¶
??? example "缩放示例"
可以通过 `???` 指定备注信息块缩放，让主文字更加清晰
缩放示例
可以通过 ??? 指定备注信息块缩放，让主文字更加清晰
备注信息块默认是关闭的，可也设置默认是 打开 的
???+ example "缩放示例"
可以通过 `???` 后增加 `+` 号，让备注信息块默认打开
缩放示例，默认打开
可以通过 ??? 后增加 + 号，让备注信息块默认打开
1.1.4.4 inline 展示¶
在类型 note | info | ... 之后增加 inline 或 inline 关键词将备注信息块和文本信息展示在同一行
这是 inline 展示
这是 bug 吗？
!!! danger inline "这是 inline 展示"
这是 bug 吗？
这不是 bug
inline 的高度好像不太好控制，加个 ---- 也不好使
这是 inline end 展示
我到右边来了~~
!!! success inline end "这是 inline end 展示"
我到右边来了~~
算了，再来一行吧
1.1.5 支持自定义新的类型¶
[TODO]