Markdown Cheat Sheet

Here you find a list of the syntax and commands used for BlastoDB.
This includes basic markdown syntax as well as the custom elements added.

Basic Markdown Syntax

Here is a short cheet-sheet for the markdown syntax that works with the parser of BlastoDB. It is based on the one cheat-sheet found on markdownguide.org, but amendet by some specific BlastoDB Features.

Element	Syntax
Heading	`# H1` `## H2` `### ...`
Bold	`bold text`
Italic	`italic text`
Highlight	`==highlighted text==`
Strikethrough	`~~The world is flat~~`
Subscript	`H~2~O`
Superscript	`X^2^`
Blockquote	`> quoted text`
Ordered List	`1. Item one` `2. Item two` `3. ...`
Unordered List	`- Item one` `- Item two` `- ...`
Task List	`- [ ] unchecked item` `- [x] checked item`
Code (inline)	`code`
Code Block	```language `code` ```
Horizontal Rule	`---`
Link	`[title](https://example.com)`
Image	`![alt text](image.jpg)`
Table	`\| Heading \| Heading \|` `\|---\|---\|` `\| Row 1 \| Row 1 \|`
Footnote	`Text[^1].` `[^1]: This is the footnote`
Heading ID	`### My Heading {#custom-id}`

The BlastoDB markdown-parser also supports HTML syntax. Here are a few more useful things you can do with that.

Element	Syntax
Linebreak	`<br>`
Link that opens a new Tab	`<a href="https://example-link.co.uk" target="_blank">title</a>`
Underline	`<ins>underlined text</ins>`
Hero Headline	`<h-hero>Title</h-hero>`
Indentations	` `

Custom Elements

Here you find a list of all the custom elements added to layout content on the website, as well as make it interactive. Read the articles about each element for more information.

Element	Syntax	Description
Tag	`[tag:tag_name]`	Visual element to display tags.
Button	`[btn:displayed_text -> page.html]`	Needs a displayed text and a link to another page.
Box	`[start:box]` Content `[end:box]`	Groups content inside. Can be used for styling.
Card	`[start:card]` Content `[end:card]`	Displays the content inside in a colored box.
Hero	`[start:hero]` Content `[end:hero]`	A full-width box. Displays content like a Card.
Cols	`[start:cols]` Content `[end:cols]`	Arranges content in columns. Resizes automatically for mobile.
Grid	`[start:grid]` Content `[end:grid]`	Arranges content in a grid. Resizes automatically for mobile.
Collector	`[collector -> collection-name; tags:true; search:true; arrange:cols]`	Reads all files in a collection and dynamically displays them as cards.