kubernetes-handbook/node_modules/gitbook-plugin-alerts/README.md

51 lines
956 B
Markdown

# gitbook-plugin-alerts
Info, warning, danger, success blockquotes for your gitbook. See it in action at [docs.hypertrack.io](https://docs.hypertrack.io).
[![npm version](https://badge.fury.io/js/gitbook-plugin-alerts.svg)](https://badge.fury.io/js/gitbook-plugin-alerts)
![Screenshot](screenshot.png)
## Installation
Add the plugin to your book.json
```json
{
"plugins": ["alerts"]
}
```
## Usage
Info styling
```
> **[info] For info**
>
> Use this for infomation messages.
```
Warning styling
```
> **[warning] For warning**
>
> Use this for warning messages.
```
Danger styling
```
> **[danger] For danger**
>
> Use this for danger messages.
```
Success styling
```
> **[success] For info**
>
> Use this for success messages.
```
## Support
Please create an [issue](https://github.com/hypertrack/gitbook-plugin-alerts/issues) for bugs and contributions.
## Possible contributions
Add config for custom styling. Send in your pull requests!