Skip to content
Snippets Groups Projects
Commit 66033aaf authored by Sean Madsen's avatar Sean Madsen
Browse files

adding extension (and documentation) for admonitions

parent 4a9884d2
No related branches found
No related tags found
No related merge requests found
......@@ -280,7 +280,43 @@ mkdocs**:
- More list items
````
## Admonitions
### Types
!!! note
I am a "note" admonition.
!!! tip
I am a "tip" admonition.
!!! warning
I am a "warning" admonition.
!!! danger
I am a "danger" admonition.
Other types
- "hint", "important" (visually identical to "tip")
- "attention", "caution" (visually identical to "warning")
- "error" (visually identical to "danger")
### Syntax
Simple example:
```md
!!! note
This feature is only available as of CiviCRM 4.5.
```
Add a custom title (make sure to quote the title):
```md
!!! danger "Don't try this at home!"
Stand back. I'm about to try science!
```
## Images
......
......@@ -3,6 +3,8 @@ repo_url: https://github.com/civicrm/civicrm-dev-docs
site_description: A guide for CiviCRM developers.
site_author: The CiviCRM community
theme: readthedocs
markdown_extensions:
- markdown.extensions.admonition
pages:
- Home: index.md
- Basics:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment