-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
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
Fix/improve documentation formatting #1575
Fix/improve documentation formatting #1575
Conversation
#1659 may cause potential merge conflict. |
I've refreshed the whole thing, rebased and resolved conflicts. |
@ohdearaugustin could you have a look? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We just need to run prettier again
It seems like that prettier will break most of the changes again. |
So I tried now several things that prettier won't destroy the indentation of the code-block in a list, but it seems like nothing works. Even an ignore block like:
My assumption is that mkdocs and prettier use different markdown libraries with different standards for code blocks in lists. I really thinking to add those files just to the ignore list to get it fixed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will merge when #1832 is fixed, then the docu should also be correctly deployed again.
Description
Fixes markdown formatting/indentation issues to properly render via mkdocs:
1. 2. 3. ...
) with1.
-based enumeration. The renderer takes care of mapping the correct index to each list element. Generally easier to maintain.monospace
formatting for package/image names.Validation steps
mkdocs serve
.raised a GitHub issue or discussed it on the projects chat beforehandNot applicableadded unit testsNot applicableadded integration testsNot applicable