Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 700 Bytes

README.md

File metadata and controls

44 lines (35 loc) · 700 Bytes

remark plugin shortcode

This plugin support shortcode in Hugo style.

Install

Run:

# npm
npm install remark-content-shortcode

# yarn
yarn add remark-content-shortcode

Example

An example is as follows:

{{% notice note %}}
this is a note
{{% /notice %}}

All the available shortcodes are:

{{% notice note %}}
this is a note
{{% /notice %}}

{{% notice info %}}
this is an info
{{% /notice %}}

{{% notice warn %}}
this is a warnning
{{% /notice %}}

{{% notice error %}}
this is an error
{{% /notice %}}

Don't forget to add a line blank behind and before each shortcode block. It's better to add a <br> behind each block.

LICENSE

MIT