Skip to content

Commit d6161e0

Browse files
authored
add note about markdown indentation (#253)
* add note about markdown indentation * Update help-style-guide.md * Update help-style-guide.md
1 parent fd7fb37 commit d6161e0

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/creating-nodes/help-style-guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ The following style guide describes how the help should be structured to ensure
1212
a consistent appearance between nodes.
1313

1414
*Since 2.1.0* : The help text can be provided as markdown rather than HTML. In this
15-
case the `type` attribute of the `<script>` tag must be `text/markdown`.
15+
case the `type` attribute of the `<script>` tag must be `text/markdown`.<br>
16+
When creating markdown help text be careful with indentation, markdown is whitespace sensitve so all lines should have no leading whitespace inside the `<script>` tags.
1617

1718
<hr/>
1819

0 commit comments

Comments
 (0)