hydra Make specification editing in markdown possible

Make specification editing in markdown possible

Open abailly-iohk opened this issue 2 years ago • 4 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.