doc: Convert HTML to Markdown #5064
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
This converts HTML markup in .md files to Markdown using the ./utils/grass_html2md.sh script.
|
In https://github.com/OSGeo/grass/pull/4792/files#diff-0947e2727d6bad8cd0ac4122f5314bb5b04e337393075bc4b5ef143b17fcbd5bR75 (not merged yet), I noticed it too and did not enable. I thought I added the exclusion in pre-commit too... it didn't have other problems after that. |
|
For the time of the conversion, even if it takes a week, ignore or disable the problematic pre-commit checks (for markdown if you want). It's quite easy to fix after the big 3-4 person effort for markdown docs is done |
|
The conversion from HTML to Markdown together with the automatic fixes removed a ton of warnings. I removed the relevant ignore and added three which did not occur with the HTML. I added |
…but not terribly and the history is not that important for these two (one is a recently added mkdocs template and the other may be even unused).
petrasovaa
approved these changes
Feb 7, 2025
github-actions
bot
added
windows
11 tasks
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.
This converts HTML markup in .md files to Markdown using the ./utils/grass_html2md.sh script.
This is committed with --no-verify. There are new or different Markdown linting rules broken and trailing spaces are not allowed.
How do we want to do it with the trailing spaces? Our pre-commit checks don't allow them, but they are used in Markdown extensively now to accommodate the various
<br>used for formatting and it is used to mimic<dt>.