Markdown Tipps & Tricks (for Jupyter Notebook)¶
Markdown writing skills are essential to portray your work in the Jupyter notebook to offer the reader a sufficient explanation of both the code and the concept.
I have collected informations for different sources. Thanks to them!
Markdown is a light markup language with a simple text syntax. Markdown should be easy to write and above all easy to read.
John Gruber developed the Markdown language in 2004 in collaboration with Aaron Swartz with the goal of enabling people to "write in an easy to read and easy to write plain text format and possibly convert it to structurally correct XHTML (or HTML)".
However, one should not assume that "Markdown" is a substitute for HTML. HTML is a format for publishing, while Markdown is a format for reading.
The syntax of markup is minimal and only applies to a tiny portion of HTML tags. The idea of Markdown is to make it easier to read, write and edit prose, without the intention of creating a syntax that only serves to quickly add HTML tags. Therefore, the formatting syntax of Markdown deals only with questions that can be expressed in plain text.
For everything else, use HTML. You don't have to make any preamble or delimitation to indicate that you are switching from Markdown to HTML - you simply use the tags.
The following examples start with some simple examples and then show some not so common tricks.
Have fun with them!