docs: highlight underscores as code block #1493
Conversation
.markdownlint.yaml
Outdated
| # MD050/strong-style | ||
| MD050: | ||
| style: "asterisk" |
There was a problem hiding this comment.
the next time CI would just failed to deploy documentation from main and we will have to create a hotfix for main branch to fix formatting
There was a problem hiding this comment.
ah, true, let me remove it
There was a problem hiding this comment.
ah, it is already failed. So, it does not matter for what reason it would fail..
There was a problem hiding this comment.
yea, but even then it does not change anything, as this file is generated after main pipeline runs, so it will fail for both cases.
Maybe just worth ading it for other files? but for that one the pipeline will fail in PR, so also not a big benefit.
There was a problem hiding this comment.
It seems fail only if the formatting is not consistent
There was a problem hiding this comment.
yea, that is the default option,
MD050:
style: "consistent"
so there are 2 possibilities:
- we add this rule and it will fail when underscores( _ ) appears due to incorrect sign being used as bolder sign,
- we do not add it and it will fail when underscores( _ ) due to inconsistent bolder signs
Co-authored-by: Viktor Tsvetkov <[email protected]>
soleksy-splunk
changed the title
Issue number:
N/A
PR Type
What kind of change does this PR introduce?
Summary
Configuration for documentation lint.
Changes
Please provide a summary of the changes.
use asterisk as bold sign
User experience
Please describe the user experience before and after this change. Screenshots are welcome for additional context.
N/A
Checklist
If an item doesn't apply to your changes, leave it unchecked.