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

[Amar Takhar (@amar)]

Amar Takhar created a merge request: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155

Project:Branches: amar/rtems-docs:myst to rtems/docs/rtems-docs:main
Author:   Amar Takhar
Assignee: Amar Takhar



## Summary

reST is no longer widely in use as a document format.  Everywhere supports MarkDown now and this is where the future of docs development is.  Little work is being done to enhance reST it's just maintenance mode now.

The format is very well documented I've added every single plugin available you can see what can be done here:

https://myst-parser.readthedocs.io/

Colon fences have been enabled which uses `` ::: `` instead of `` ``` `` for fencing.  It's easier to read under parsers that don't support CommonMark like GitLab or others where it can wallow settings under using backticks as that's commonly used for code.

<!--Default settings, if it is a dropdown it will set after submission-->

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155
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/20250218/9e6ccd7f/attachment.htm>