Make specification editing in markdown possible (tidy first)

Question

Make specification editing in markdown possible (tidy first)

abailly-iohk opened this issue 6 months ago · comments

So far, the specification was written in LaTex and rendered to a PDF. LaTeX was a good choice because of its expressiveness on math expressions, but not so great a choice for pull requests and the entry barrier is quite high. The majority of documentation around Hydra and Mithril is written using Markdown and rendered into a webpage using a static site generator, currently Docusaurus. Most modern Markdown renderers do support LaTeX-style math nowadays, even the normal GitHub file preview.

Hence, we aim to be using more approachable Markdown format to write the specification, but still being able to use LaTeX math and LaTeX macros (which are still heavily used in the spec), to produce both, a PDF and HTML rendering.

Arnaud Bailly · Answer 1 · Thu Nov 30 2023 18:43:14 GMT+0800 (China Standard Time)

Blocked on decision about what to do with GIF

Sebastian Nagel · Answer 2 · Fri Dec 01 2023 16:25:55 GMT+0800 (China Standard Time)

Blocked on decision about what to do with GIF

Not really. The GIF was only for the monthly report #1189

Arnaud Bailly · Answer 3 · Fri Dec 01 2023 16:53:01 GMT+0800 (China Standard Time)

OK, then it's unblocked.