-
Notifications
You must be signed in to change notification settings - Fork 165
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
doc: Convert HTML to Markdown #1332
Conversation
This converts HTML markup in .md files to Markdown using the ./utils/grass_html2md.sh script from core.
Running The suggestion is to remove --- a/src/raster/r.fuzzy.system/r.fuzzy.system.md
+++ b/src/raster/r.fuzzy.system/r.fuzzy.system.md
@@ -14,7 +14,7 @@
of rule file. Lines beginning with **\#** are comments.
```text
- $ set_name {side; points; boundary_shape; hedge; height }
+ set_name {side; points; boundary_shape; hedge; height }
```
@@ -44,7 +44,7 @@
An example of fuzzy sets definition:
```text
- $ moderate {both; 90,100,120,130; sshaped; 0; 1}
+ moderate {both; 90,100,120,130; sshaped; 0; 1}
```
@@ -79,7 +79,7 @@
An example of fuzzy rules definition:
```text
- $ small {distance = high & elev = high}
+ small {distance = high & elev = high}
``` |
Fortunately, General linting / GitHub Super Linter workflow clarified for me what are the issues, so I'm ignoring them for now, but unfortunately markdownlint triggers the warning for language set to text. Maybe, we need to use a custom language. (?) |
@wenzeslaus Which Rule was trigger this warning? |
Never mind I see it. |
I mean later, in some following PR. |
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.
From the files I've spot check this looks good to me. The only issues I've found were existing bugs in the origin html, so unrelated to this PR.
This converts HTML markup in .md files to Markdown using the ./utils/grass_html2md.sh script from core.
In addition to the automatic conversion it:
It further adjusts linting to accommodate the auto-converted Markdown.
It does not touch r.landscape.evol because that tool has already had Markdown documentation (which needs to be revised manually as needed).