From 5ceb7bbdbc787a3253bb7891dc005c7b51f4650c Mon Sep 17 00:00:00 2001 From: Larry Ullman Date: Sun, 8 Jun 2014 16:31:37 -0400 Subject: [PATCH] Added a "Blocks" section --- docs/documentation_style_guide.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/documentation_style_guide.md b/docs/documentation_style_guide.md index f26a54fe95..f56603736d 100644 --- a/docs/documentation_style_guide.md +++ b/docs/documentation_style_guide.md @@ -16,6 +16,15 @@ Guidelines to go by when writing or editing any Yii documentation. ## Formatting +## Blocks + +Blocks use the Markdown `> Type: `. There are four block types: + +* `Warning`, for bad security things and other problems +* `Note`, to emphasize key concepts, things to avoid +* `Info`, general information (an aside); not as strong as a "Note" +* `Tip`, pro tips, extras, can be useful but may not be needed by everyone all the time + ## References * Yii 2.0 or Yii 2 (not Yii2 or Yii2.0)