GitBook 是一个使用 Markdown 写作的文档编写工具,可以将 Markdown 文件编译成静态网页。GitBook 提供了很多个性化的插件,其中一个非常有用的插件就是:gitbook-plugin-alerts,它提供了几个弹框效果。
gitbook-plugin-alerts 的介绍
gitbook-plugin-alerts 是 GitBook 的一个插件,通过它可以在 Markdown 文本中使用弹框来增强文本的表现力,以更好地提高文档的可读性和可视性。
gitbook-plugin-alerts 提供了以下几个类型的弹框:
- info
- warning
- danger
- success
安装 gitbook-plugin-alerts
首先在全局安装 GitBook:
npm install -g gitbook-cli
然后在你的 GitBook 项目下安装 gitbook-plugin-alerts:
npm i gitbook-plugin-alerts --save-dev
在 GitBook 中使用 gitbook-plugin-alerts
在 Markdown 中使用 gitbook-plugin-alerts 很简单,只需要在文本中写一个类似下面这样的标签:
{% alert %} My Alert! {% endalert %}
其中 My Alert!
为弹框内容。
若要设置其他类型的弹框,只需在 {% alert %}
标签中添加对应类型的类名。例如:
- 信息框:
{% alert type="info" %}Info Alert!{% endalert %}
- 警告框:
{% alert type="warning" %}Warning Alert!{% endalert %}
- 危险框:
{% alert type="danger" %}Danger Alert!{% endalert %}
- 成功框:
{% alert type="success" %}Success Alert!{% endalert %}
示例代码
下面是一个例子,展示如何使用 gitbook-plugin-alerts:
-- -------------------- ---- ------- -- ----- -- -- ------ -- -------- -- -- ----- ----------- -- ---- ------ -- -------- -- -- ----- -------------- -- ------- ------ -- -------- -- -- ----- ------------- -- ------ ------ -- -------- -- -- ----- -------------- -- ------- ------ -- -------- --
结论
通过本教程,你已经掌握了 npm 包 gitbook-plugin-alerts 的使用方法。使用 gitbook-plugin-alerts 可以让你的 GitBook 文档更加生动,让读者更好地理解文档。在 GitBook 中使用 gitbook-plugin-alerts 并不需要过高的技术要求,只需要按照本教程的步骤进行操作即可。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedaa9cb5cbfe1ea0610529