search

ericgibert / supersid

Cross-platform Sudden Ionospheric Disturbances (SID) monitor
MIT License
19 stars 10 forks source link

ConfigHelp.md: Fix format/rendering issue in documentation #17

Open cyber-g opened 3 years ago

cyber-g commented 3 years ago

There is a small formatting/rendering issue for the markdown ConfigHelp.md documentation file.

Some sections are highlighted by div tags (example : <div id='id-section1'/>) These tags are currently directly followed by subsection titles (example : ## [PARAMETERS] ##)

Issue : the subsection title is not properly rendered on the web interface.

Solution : There should be an empty line after those tags for having a proper rendering of the subsection titles.

This PR fixes this rendering issue by adding the appropriate empty lines after the div tags.

sberl commented 3 years ago

Hey cyber-g. Thanks for the fix. Eric is kind of on break from maintaining this code. The current development activity is over at https://github.com/sberl/supersid. If it isn't too much trouble, could you open the PR over there?

Thanks.

cyber-g commented 3 years ago

Sure ! I will proceed to the PR at https://github.com/sberl/supersid any time soon ; I guess I will have to fetch the available new commits before. Should be done in the next few days. Best regards

cyber-g commented 3 years ago

Should I close this PR since it is continued on fork of @sberl ? (https://github.com/sberl/supersid/pull/1)