GitHub Markdown starter

Basics of Markdown syntax

This is a three minutes tutorial of GitHub version of Markdown markup language. To create the above title GitHub Markdown starter, the section Basics of Markdown syntax, and this paragraph put the following lines in the markdown-started.md file:

# GitHub Markdown starter

## Basics of Markdown syntax

This is a three minutes tutorial of GitHub version of Markdown markup language.
To create the title _GitHub Markdown starter_, the section _Basics of Markdown syntax_
and __this__ paragraph put the following lines in the `markdown-starter.md` file:

The code block above is created by putting the code between two lines with triple backticks. The word “markdown” on the first line ensures proper Markdown syntax highlighting:

```markdown
# GitHub Markdown starter
```

An inline code like `markdown-starter.md` is placed in single backticks. Regular text paragraphs are delimited by empty lines and start from the beginning of line. A quoted text block (like one below) begins with “> “ on each line:

Note underscore signs around _GitHub Markdown starter_. This is italic text while __bold__ or **bold** produces bold typeface. By the way, italic bold is coded as ***italic bold*** or ___italic bold___. The ~~strikethrough~~ text is also allowed by wrapping it in two tildas ~~strikethrough~~.

Links

Here is a link to TELLab2 login page:

[login page](https://lab2.tellab.org/passport/login)

Now, let’s show a couple of links to Markdown syntax, especially, its GitHub version.

[Markdown](https://en.wikipedia.org/wiki/Markdown "Markdown in Wikipedia")
[GitHub version](
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
"Markdown syntax")

The shown examples of links are absolute (full) URLs, but relative links to files in the docs/user directory are also OK. For example, [Quick-start guide](quick_start.md) is a relative link to the Markdown source docs/user/quick_start.md of Quick-start guide. Plus, you may link sections in the rendered document. The link is exposed by hovering over the section heading. For example, [syntax](#basics-of-markdown-syntax) points to the above syntax section.

Images

The syntax for images is similar to links, just add ! in front of image link like this:

![Ice age fauna](https://upload.wikimedia.org/wikipedia/commons/e/e6/Ice_age_fauna_of_northern_Spain_-_Mauricio_Antón.jpg "Ice age fauna")

The actual image file does not need to be stored in your GitHub repository. It may come from an external site. Here is an illustration “Ice age fauna of northern Spain” by Mauricio Antón licensed under CC BY 2.5 and stored somewhere at Wikimedia Commons:

Not covered topics

The purpose of this tutorial is getting you started with GitHub built-in Markdown editor. There are common language elements, e.g. lists and footnotes, not covered here. Follow the links mentioned above to learn more. Go to GitHub Flavored Markdown for formal Markdown specification. Another unanswered question is how to assemble separate Markdown files into a browse-and-search documention in Read the Docs format.