Markdown
Markdown
is a very lightweight plain text markup language for writing documentation. It is easy to read, easy to write, and easy to render to other markup languages like HTML.
Every document needs a few headings, numbered or unnumbered lists, bold, italic, and underline, links, images, tables, and the like. With Markdown
these can be specified with simple common characters.
Markdown
can easily be rendered to HTML, for example, and there is also tooling that can render it to Word documents or PDF files.
By Convention the file extension for Markdown
files is .md
.
Frontmatter is an “extension” of Markdown
that allows for adding meta data.
By default links in Markdown
use the following syntax:
md
More modern tools support the Wiki Syntax
:
md
Here the text of the link and the target of the link are identical to the name of the document that is referenced. This is much easier to read and to type.
For more information on the Markdown
syntax, see https://www.markdownguide.org/basic-syntax/.