cupper-hugo-theme/exampleSite/content/patterns/writing/notes-and-warnings.md

38 lines
1.4 KiB
Markdown
Raw Normal View History

2017-06-27 21:15:38 +02:00
+++
title = "Notes & warnings"
+++
2017-11-02 16:37:06 +01:00
**Cupper** acknowledges that simple markdown is limiting when it comes to writing compelling documentation, so it provides a number of "shortcodes". Shortcodes offer a simple syntax for including rich content. For example, **Cupper** provides shortcodes for including notes and warnings.
2017-06-27 21:15:38 +02:00
## Notes
You may wish to pick out some content in your pattern's documentation as a note — an aside to the main thrust of the pattern's description. This is possible using the following syntax:
{{<codeBlock>}}
&#x7b;{% note %}}
This is a note! It's something the reader may like to know about but is supplementary to the main content. Use notes when something may be interesting but not critical.
&#x7b;{% /note %}}
{{</codeBlock>}}
Notes render like this:
{{% note %}}
This is a note! It's something the reader may like to know about but is supplementary to the main content. Use notes when something may be interesting but not critical.
{{% /note %}}
## Warnings
Warnings are like notes, but with more urgency.
{{<codeBlock>}}
&#x7b;{% warning %}}
This is a warning! It's about something the reader should be careful to do or to avoid doing. Use warnings when something could go wrong.
&#x7b;{% /warning %}}
{{</codeBlock>}}
2017-06-29 09:22:37 +02:00
Warnings render like this:
2017-06-27 21:15:38 +02:00
{{% warning %}}
This is a warning! It's about something the reader should be careful to do or to avoid doing. Use warnings when something could go wrong.
{{% /warning %}}