hexo-admonition

1.1.2 • Public • Published

Hexo-admonition 插件安装使用指南

简介

Hexo 内容辅助插件,支持将类似 reStructuredText 的警告提示块添加到 Markdown 文档中。例如 note、warning、error 等提示块,效果如图:

Hexo-admonition 示例效果

开发这个插件的动机,是想让 hexoMaterial for MkDocs 的提示信息兼容,让系列文章在基于 MkDocs 搭建的子站中有更好的阅读体验。

查看更多内容,请访问博文:Hexo-admonition 插件安装使用指南

安装说明

安装插件

npm install hexo-admonition --save

使用指南

语法说明

Hexo-admonition 遵循一种简单的语法:每个块都以 !!! 开头,然后是代表提示类型的关键字(type)及标题(title)。例如:

!!! note Hexo-admonition 插件使用示例
    这是基于 hexo-admonition 插件渲染的一条提示信息。类型为 note,并设置了自定义标题。
 
    提示内容开头留 4 个空格,可以有多行,最后用空行结束此标记。
 

在 Hexo 渲染前,将被转换成如下内容:

<div class="admonition note ">
  <p class="admonition-title">Hexo-admonition 插件使用示例</p>
  <p>这是基于 hexo-admonition 插件渲染的一条提示信息。类型为 note,并设置了自定义标题。</p>
  <p>提示内容开头留 4 个空格,可以有多行,最后用空行结束此标记。</p>
</div>

最终呈现效果如下:

hexo-admonition 插件 note 提示示例

支持的类型

提示类型 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),并按自己喜好修改:

.admonition {
  margin: 1.5625em 0;
  padding: .6rem;
  overflow: hidden;
  font-size: .64rem;
  page-break-inside: avoid;
  border-left: .3rem solid #42b983;
  border-radius: .3rem;
  box-shadow: 0 0.1rem 0.4rem rgba(0,0,0,.05)0 0 0.05rem rgba(0,0,0,.1);
  background-color: #fafafa;
}
 
p.admonition-title {
  position: relative;
  margin: -.6rem -.6rem .8em -.6rem !important;
  padding: .4rem .6rem .4rem 2.5rem;
  font-weight: 700;
  background-color:rgba(66, 185, 131, .1);
}
 
.admonition-title::before {
  position: absolute;
  top: .9rem;
  left: 1rem;
  width: 12px;
  height: 12px;
  background-color: #42b983;
  border-radius: 50%;
  content: ' ';
}
 
.info>.admonition-title.todo>.admonition-title {
  background-color: rgba(0,184,212,.1);
}
 
.warning>.admonition-title.attention>.admonition-title.caution>.admonition-title {
  background-color: rgba(255,145,0,.1);
}
 
.failure>.admonition-title.missing>.admonition-title.fail>.admonition-title.error>.admonition-title {
  background-color: rgba(255,82,82,.1);
}
 
.admonition.info.admonition.todo {
  border-color: #00b8d4;
}
 
.admonition.warning.admonition.attention.admonition.caution {
  border-color: #ff9100;
}
 
.admonition.failure.admonition.missing.admonition.fail.admonition.error {
  border-color: #ff5252;
}
 
.info>.admonition-title::before.todo>.admonition-title::before {
  background-color: #00b8d4;
  border-radius: 50%;
}
 
.warning>.admonition-title::before.attention>.admonition-title::before.caution>.admonition-title::before {
  background-color: #ff9100;
  border-radius: 50%;
}
 
.failure>.admonition-title::before,.missing>.admonition-title::before,.fail>.admonition-title::before,.error>.admonition-title::before{
  background-color: #ff5252;;
  border-radius: 50%;
}
 
.admonition>:last-child {
  margin-bottom: 0 !important;
}

License

MIT

参考

Package Sidebar

Install

npm i hexo-admonition

Weekly Downloads

182

Version

1.1.2

License

MIT

Unpacked Size

8.27 kB

Total Files

5

Last publish

Collaborators

  • lxl80