Markdown formatting changes #104
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bug fix - update group not included
Some markdown visualisation libraries don't render the table properly if there's no newline or heading directly before the table. In this case, if a config item has no assignments, the table is inserted on the line directly below the description which can break formatting.
Markdown will fail to render text properly if it contains some combinations of special characters. It's probably unnecessary, but if we escape everything then there's no question about whether it will render properly.
Markdown provides backslash escapes for the following characters:
```
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark
```
almenscorner
approved these changes
Apr 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some markdown visualisation libraries (MkDocs in my case) don't render the table properly if there's no blank line or heading directly before the table. In this case, if a config item has no assignments, the table is inserted on the line directly below the description which causes it to be displayed as raw text rather than a table.
This PR adds a
### Configurationheading before allconfig_table. Alternatively the heading could be replaced with a simple newline.Additionally, when using some special characters in descriptions, they can have unforeseen effects on the rendered markdown. If all special characters are escaped, then it removes the risk of this happening. Possibly this is overkill and completely unnecessary, I can remove it if you think so.