Add documentation that markdown is not rendered when including variables#2258
Add documentation that markdown is not rendered when including variables#2258yucheng11122017 wants to merge 2 commits into
Conversation
…dDocumentationOnIncludeVariable
| </span> | ||
| </include> | ||
|
|
||
| <panel header="Markdown not rendered when including a variable"> |
There was a problem hiding this comment.
The heading should let the reader decide quickly between expanding and reading the panel or skipping it. This one is hard to decide (is this a tip, advanced technique, caveat, etc.?), and the reader will have to expand the panel to figure out what it's about.
There was a problem hiding this comment.
Hmmm how about "If trying to include a variable with markdown" or something like that?
| Code that uses include fragment: | ||
| ```html | ||
| <include src="index.md#fragment-id" /> | ||
| ``` |
There was a problem hiding this comment.
Something is not right here. I don't think variables are meant to be used as include fragments in the first place. Although it would be nice 'trick' to be able to do so, I don't think it is an advertised feature. Variable values are inserted using the {{ v_name }} instead. Does our UG say variables can be included in this way?
There was a problem hiding this comment.
Oh I see I see. In that case, I will close this PR and the corresponding issue :)
2 participants
What is the purpose of this pull request?
Related to #2211
Overview of changes:
Adding documentation about the bug where markdown is not rendered when including variable
Included it in a panel in includes so users don't have to view it if not relevant
Anything you'd like to highlight/discuss:
I did not include the reason for this error because its a bit complicated to explain and users wouldn't need to understand it.
Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
Document bug where including variables does not render markdown
Checklist: ☑️