Hexo-admonition 插件安装使用指南
简介
Hexo 内容辅助插件,支持将类似 reStructuredText 的警告提示块添加到 Markdown 文档中。例如 note、warning、error 等提示块,效果如图:
开发这个插件的动机,是想让 hexo 与 Material for MkDocs 的提示信息兼容,让系列文章在基于 MkDocs 搭建的子站中有更好的阅读体验。
查看更多内容,请访问博文:Hexo-admonition 插件安装使用指南。
安装说明
安装插件
npm install hexo-admonition --save
使用指南
语法说明
Hexo-admonition 遵循一种简单的语法:每个块都以 !!!
开头,然后是代表提示类型的关键字(type
)及标题(title
)。例如:
!!! note Hexo-admonition 插件使用示例 这是基于 hexo-admonition 插件渲染的一条提示信息。类型为 note,并设置了自定义标题。 提示内容开头留 4 个空格,可以有多行,最后用空行结束此标记。
在 Hexo 渲染前,将被转换成如下内容:
Hexo-admonition 插件使用示例 这是基于 hexo-admonition 插件渲染的一条提示信息。类型为 note,并设置了自定义标题。 提示内容开头留 4 个空格,可以有多行,最后用空行结束此标记。
最终呈现效果如下:
支持的类型
提示类型 type
将用作 CSS 类名称,暂支持如下类型:
note
info, todo
warning, attention, caution
error, failure, missing, fail
设置/隐藏标题
标题 title
是可选的,当未设置时,将以 type
作为默认值:
!!! warning 这是一条采用默认标题的警告信息。
效果如下:
如果不想显示标题,可以将 title
设置为 ""
:
!!! Warning "" 这是一条不带标题的警告信息。
效果如下:
嵌套 markdown 标记
在 hexo-admonition
内部,还可以嵌套标准 Markdown 标签,例如:
!!! node "嵌套链接及引用块" 欢迎访问我的博客链接:[悟尘纪](https://www.lixl.cn) >这里嵌套一行引用信息。
效果如下:
样式配置
将如下样式放入 hexo 主题的自定义样式文件中(如:my.css
),并按自己喜好修改:
License
MIT