search

epics-docs / epics-docs

Top level project for EPICS document on readthedocs.
https://docs.epics-controls.org
Other
11 stars 35 forks source link

Convert all rst files to md #24

Open gabrielfedel opened 10 months ago

gabrielfedel commented 10 months ago

As we are recommending markdown as default format (file:///home/gabrielfedel/events/EPICSDocumentathon2023/epics-docs/build/html/CONTRIBUTING.html#style-guide) it would be good to have all the documents on that format.

Suggestion of tool to help on that: https://pandoc.org/

minijackson commented 10 months ago

For example with pandoc:

pandoc "$FILE" -t markdown --wrap=preserve --reference-links --reference-location=section
ttkorhonen commented 3 weeks ago

I removed the "good for newcomers" tag. This can have a lot of implications, especially changing the index files, so it is not a good first task. Sorry for you who started working on this! (Converting a single file that is a "leaf" is fine; changing "all", and especially the indices, needs careful attention.)