We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
This is a list of little things with the Mkdocs version https://open-cmsis-pack.github.io/cmsis-toolbox/
In the new documentation, table text does not longer wrap. See: https://open-cmsis-pack.github.io/cmsis-toolbox/#revision-history
Explore if this mkdocs/mkdocs#3035 can be used to make it appear better.
The button Edit on GitHub is great to let users fix little things. However, it does not go to the correct directory. Can this be addressed.
Having a width limit improves readability. However, I suggest to increase the setting slightly so that examples like here don't require a scroll bar. https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#pack-name-conventions
Potential solution: Add this to extra *.css. (see also mkdocs/mkdocs#3598)
.wy-nav-content { max-width: 900px; }
Enable the copy code button (https://squidfunk.github.io/mkdocs-material/reference/code-blocks/)
The integrated GitHub formatter offers different bullet point spacing. An empty line in a bullet point list increases spacing. See the difference on this pages: https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/index.md https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/overview.md
Can something similar be achieved with Mkdocs?
A: Need to review Python-Markdown/markdown#1497
Mkdocs does not consider the bullet point indents. See the difference on this page: https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/overview.md https://open-cmsis-pack.github.io/cmsis-toolbox/overview/
To fix this use 4 intends. Note that markdownlint should be configured for this. In VS Code add to settings.json
"markdownlint.config": { "ul-indent": { "indent": 4 } },
The text was updated successfully, but these errors were encountered:
Further rework to improve ReadTheDocs. Fixed:
aef3c73
- Open-CMSIS-Pack/devtools#1871 - Open-CMSIS-Pack#234 - Open-CMSIS-Pack#247
Further rework to improve ReadTheDocs (#249)
b484176
Fixes: - Open-CMSIS-Pack/devtools#1871 - #234 - #247
KeilChris
No branches or pull requests
Is there an existing issue for this?
This is a list of little things with the Mkdocs version https://open-cmsis-pack.github.io/cmsis-toolbox/
✔️ Wrap Table Text
Current Behavior
In the new documentation, table text does not longer wrap.
See: https://open-cmsis-pack.github.io/cmsis-toolbox/#revision-history
Expected Behavior
Explore if this mkdocs/mkdocs#3035 can be used to make it appear better.
✔️ Edit on GitHub
The button Edit on GitHub is great to let users fix little things. However, it does not go to the correct directory. Can this be addressed.
Max Width
Having a width limit improves readability. However, I suggest to increase the setting slightly so that examples like here don't require a scroll bar.
https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#pack-name-conventions
Potential solution: Add this to extra *.css. (see also mkdocs/mkdocs#3598)
Copy Code Button
Enable the copy code button (https://squidfunk.github.io/mkdocs-material/reference/code-blocks/)
Bullet Point List Spacing
The integrated GitHub formatter offers different bullet point spacing. An empty line in a bullet point list increases spacing.
See the difference on this pages:
https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/index.md
https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/overview.md
Can something similar be achieved with Mkdocs?
A: Need to review Python-Markdown/markdown#1497
✔️ Bullet Point Indenting
Mkdocs does not consider the bullet point indents. See the difference on this page:
https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/overview.md
https://open-cmsis-pack.github.io/cmsis-toolbox/overview/
To fix this use 4 intends. Note that markdownlint should be configured for this. In VS Code add to settings.json
The text was updated successfully, but these errors were encountered: