enhance docs readability #2612
Merged
enhance docs readability #2612
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
SMillerDev
reviewed
Mar 10, 2024
Seems like that makes no difference, mkdocs still renders the comments nicely |
Signed-off-by: Petra Mirelli <80395360+iNtEgraIR2021@users.noreply.github.com> Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
Signed-off-by: Petra Mirelli <80395360+iNtEgraIR2021@users.noreply.github.com> Co-authored-by: Sean Molenaar <SMillerDev@users.noreply.github.com> Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
Grotax
force-pushed
the
iNtEgraIR2021-enhance-docs-readability
branch
from
d80e834 to
1dab00d
Compare
|
Thanks :) |
Grotax
approved these changes
Apr 1, 2024
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.
Summary
I applied all findings returned by
markdownlintfor the Markdown docs files of this project to enhance the readability of the code.I also enabled the the syntax highlighting for the code blocks to further enhance the readability.
Until now the docs where not easy to read in dark(er) environments so I also enabled the automatic theme switcher based on the browser's
prefers-color-schemeheader.Checklist