0.0.2 • Published 2 years ago

honkit-plugin-alert-msg v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

honkit-plugin-alert-msg

Create alerts like gitbook-plugin-flexible-alerts using blocks of honkit.

Usage

Simply create "alert" block in your markdown.

{% alert type="note", style="callout" %}
This is a note.
{% endalert %}

This block is expanded into the following HTML by default.

<div class="alert info callout">
    <p class="title">
        <i class="fa fa-info-circle"></i>
        "Note"
    </p>
    <p>This is a note.</p>
</div>

Available kwargs

  • type
    • note
    • tip
    • warning
    • danger
    • and you can add some custom type
  • style
    • callout
    • flat

Installation

install this module

on project root

npm install honkit-plugin-alert-msg

Add plugin in book.json

{
    "plugins": [
        "alert-msg"
    ]
}

Now you can use alert-msg by honkit build, honkit serve and so on.

Reference

Author

Nanamiiiii - Akihiro Saiki