Documentation | Convert files from reST to MarkDown (!155)

[Amar Takhar (@amar)]

Amar Takhar commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120206


FYI to add on my `mdformat` comments https://github.com/hukkin/mdformat .. there are very few settings you can see what they are here: [https://gitlab.rtems.org/administration/integration/-/blob/main/config/mdformat/mdformat.toml](https://gitlab.rtems.org/administration/integration/-/blob/main/config/mdformat/mdformat.toml?ref_type=heads) .. outside of this there are no other settings.  So anything to do with formatting is out of my hands unless the suggestion is we don't use a formatter.  I opened an issue upstream for another problem and was told there will be no new configuration it's an opinionated formatter it is what it is.  It's by far the best one though.

There are issues with the formatter doing strange things it's best to look at the output from the old docs to see if it's the same if it's not then there are issues in the markup that need to be fixed and the formatter re-run so it can pickup the correct changes.  I had to make quite a few fixes that were hard errors before converting so I wouldn't be surprised if there are issues with the markup that are making the formatter think it's a different type of markup than what we are intending and formatting it as such.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120206
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20250225/052490b1/attachment-0001.htm>