Markdown Syntax

Overview

Here you find an overview of the most useful elements of the markdown syntax for BlastoDB, including examples.

If you only want to quickly check the syntax check out the markdown cheat-sheet.

We also extendet the markdown syntax by costom components, you can learn more about that here.


Heading

You can create headlines with #:

# This is an H1 Headline
## This is an H2 Headline
### This is an H3 Headline
#### This is an H4 Headline
##### ...

We also defined a heading that is ridiculusly large, to be used with the hero at the begining of a page:

<h-hero>This is a Hero Headline</hero>

View how they will be rendered in the style guide.

Text Formatting

You can easily format text, for example to be bold or italic.

Here are the formating options:

You can also put text insubscript or insuperscript:

You can also combine the formatting:

There is no command for underlining text, as underlined text is usually associated with links. If you want to underline text anyway, you can do that with this HTML code:

Lists

Unordered Lists

You can create unordered lists with a - or a *:

- first item
- second item
- third item
- ...

Or you can use a *:

* first item
* second item
* third item
* ...

Ordered Lists

You can create ordered lists with 1. , 2. , and so on:

1. first item
2. second item
3. third item
4. ...
  1. first item
  2. second item
  3. third item
  4. ...

Task Lists

You can also create a task list with `- [ ] :

- [ ] This is an unchecked item
- [x] This is a checked item
- [ ] ...

Horizontal Rules

You can create horizontal rules to separate content with ---. Make shure that you leave one line of space between the last paragraph and the horizontal rule. Also, there must be no other characters in the same line as the horizontal rule.

Here is some content.

---
Here is other content that I wand to be separated.

Here is some content.


Here is other content that I wand to be separated.

Links

This section explains how to write links in markdown. In-text markdown links can be used both to link to internal and external websites. If you use links outside of text, read the styleguide on links and buttons.

You can create a link, for example to the website uf the University of Kent:

You can find the website of the university of kent [here](https://www.kent.ac.uk/).

You can find the website of the university of kent here.

If you want to link to a webpage within BlastoDB, then it is recommendet that you do not use the full web address, but the relative address of the page. Essentially, yoh leave out the https://www.blastodb.com, and directly past the link of the sub-page. If you want to link to the Subtypes page, you would write: https://www.blastodb.com/subtypes/

You can find info about the subtypes of Blastocystis [here](/subtypes/).

You can find info about the subtypes of Blastocystis here.

If you want to link to the homepage, you can do that with [BlastoDB](/) -> BlastoDB.

If you want to create a link that opens a new tab in the browser, you need to use HTML code:

This <a href="https://www.kent.ac.uk/" target="_blank">link</a> opens a new Tab.

This link opens a new Tab.

Similarly, you can link internaly to websites of BlastoDB with:

This opens the <a href="/subtypes/" target="_blank">subtypes</a> in a new Tab.

This opens the subtypes in a new Tab.

Linking to a Headline

Instead of linking to a webpage, you can also link to a headline. For this, you need to add an ID to the headline like this:

# Links {#links}

Now, you can link to the headline of a page by adding the ID to the link:

Images

You can render images like this: ![description text if image can't be loaded](image.png) As an input, you can use:

Tasos

Please make shure you have the rights to the image you want to display on the website!

Paragraphs

Add a blank line to create a paragraph between two lines of text:

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Line Breaks

You can also add <br> to break the line. You can add multiple in a row to create multiple blank lines:

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.<br>Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.<br><br><br>Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.


Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Indentations

You can add a space with &nbsp;. Adding multiple together creates indentations:

This text is not indented.

&nbsp;&nbsp;&nbsp;This text is indented.

This text is not indented.

   This text is indented.

Blockquote

You can create a blockquote using:

This is a normal text
> This is a quote.<br>With a second line, normal linebreaks do not work here!

This is a quote
With a second line, normal linebreaks do not work here!

Tables

You can add tables in markdown. However, they are a bit tricky to write in free-form text. We recomend using a markdown table generator.

| Heading | Heading |
|---|---|
| Row 1 | Row 1 |
Heading Heading
Row 1 Row 1

Code

Inline Code

If you enclose a word or a phrase in backticks (`), then they will be rendered as code:

This phrase contains a `code statement`.

This phrase contains a code statement.

Code Blocks

For multi-line code, wrap the block in triple backticks. You can add a language label after the opening backticks:

```markdown
| Heading | Heading |
|---|---|
| Row 1 | Row 1 |
```
| Heading | Heading |
|---|---|
| Row 1 | Row 1 |

The language label (python, markdown, HTML, etc.) does nothing here and can be left out.

Footnotes

You can add footnotes. These will automatically be rendered at the bottom of the page, no matter where you put the description in the file.

This is a text[^1].
This is some more Text[^2].

[^1]: First Footnote.
[^2]: Second Footnote.

This is a text[1]. This is some more Text[2].

Example of a Markdown Text

### Small Markdown Example:

With this *markdown* text I wand to quickly **highlight** some of the features of the language.
You can create **bold** or *italic* text, [links to websites](https://www.blastodb.com) and much more:
1. Numbered Lists
2. Unnumbered Lists (with a "-" instead of the number)
3. Headlines (starting with "#")
4. And even images!

Small Markdown Example:

With this markdown text I wand to quickly highlight some of the features of the language. You can create bold or italic text, links to websites and much more:

  1. Numbered Lists
  2. Unnumbered Lists (with a "-" instead of the number)
  3. Headlines (starting with "#")
  4. And even images

  1. First Footnote. ↩︎

  2. Second Footnote. ↩︎