Gaiden Extension: Admonition
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
extensions/admonition
images
wrapper
.gitignore
README.md
config.groovy
gaidenw
gaidenw.bat
pages.groovy

README.md

Gaiden Extension: Admonition

This is a good example of using Gaiden Extension effectively.

Installation

  1. Check out or download this repository.
  2. Copy extensions/admonition directory into your gaiden project.
  3. Write a following admonition syntax in your Markdown page.

Admonition syntax

The important point is that the Markdown source also is not so ugly.

Basic

 **NOTE**: This is a simple description.

example-oneline

 > **NOTE**
 >
 > This is a description with multiple lines in source.
 > How about?

example-multilines

 > **NOTE**: This is title!
 >
 > This is an admonition with title.

example-with-title

Admonition types

You can use NOTE, TIP, WARNING and IMPORTANT.

 **NOTE**: This is an admonition of `NOTE`.

example-note

 **TIP**: This is an admonition of `TIP`.

example-tip

 **WARNING**: This is an admonition of `WARNING`.

example-warning

 **IMPORTANT**: This is an admonition of `IMPORTANT`.

example-important