more docs around gatsby-remark-custom-blocks (#5962)

gatsbyjs · Jun 19, 2018 · 5504d8b · 5504d8b
1 parent 2e55615
commit 5504d8b
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/packages/gatsby-remark-custom-blocks/README.md b/packages/gatsby-remark-custom-blocks/README.md
@@ -29,3 +29,25 @@ plugins: [
   },
 ]
 ```
+
+Use the following Markdown syntax to create blocks in your file:
+
+```
+[[danger]]
+| content
+
+[[info]]
+| content
+```
+
+This will wrap your contents in `div`s with the corresponding classes:
+
+```html
+<div class="custom-block-danger">
+  <p>content</p>
+</div>
+
+<div class="custom-block-info">
+  <p>content</p>
+</div>
+```