gofair-foundation / fip

FIP Wiki
https://gofair-foundation.github.io/fip/
Other
1 stars 4 forks source link

Choose between Markdown and reStructured Text #27

Closed norbertvandijk closed 8 months ago

norbertvandijk commented 10 months ago

We may have to reconsider the change from MKDocs to Sphinx. MkDocs is relatively straightforward and works best with Markdown. Sphinx is less straightforward but has richer features, is more advanced and works best with reStructured Text although with the use of the proper package it can also process Markdown which it does in our wiki now.

MkDocs may be more suited for maintenance of basic documentation written in markdown than Sphinx with Sphinx possibly being overly complicated for our purposes.

I will look into it.

mabablue commented 10 months ago

well, I have no experience with neither those so... ask either Anne or Robin

norbertvandijk commented 10 months ago

I always want to comprehend things myself first in order to be able to judge the advice of others. That is how I work. That being said, of course I will consult Anne or Robin in this. Consult the working document.

norbertvandijk commented 9 months ago

The best choice for the near future may be Markdown with the MkDocs static site generator with the Material theme.