Markdown Examples#

H1 is alwas reserved for nav

Headers#

This is a heading 3#

This is a heading 4#

This is a heading 5#

This is a heading 6#

Links#

Predefined way of using links so that they do not break when building mkdocs

Web#

Obsidian How To

Image#

Important image names are not aloud to have spaces!

To pages#

How does this work if pages have same name?

Link to the Obsidian Page

To a section#

How does this work if pages have same name?

Link to the Obsidian Page

Emphasis#

This will also be italic
This text will be bold

Lists#

Sadly don't work as expected for some reason.

• Item 1
• Item 2
• Item 2a

• Item 2b

• Item 1

• Item 2
• Item 3
• Item 3a
• Item 3b

Code Blocks#

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

Task list#

• #tags, links, formatting supported
• list syntax required (any unordered or ordered list supported)
• [?] this is also a complete item (works with every character)
• this is an incomplete item

Tables#

Math#

Non inline latex must have a space afterwards! You can also do inline math like $1^2+1=2$ Obsidian uses Mathjax. You can check which packages are supported in Mathjax here. Also more here

Diagram#

You can also use links to notes inside diagrams.

Admonitions#

Use Admoinitions in mkdocs

So that this works nicely with mkdocs before building I need to remove all s otherwise it looks stupid. Also all admonitions need to be added to mkdocs put with ad- prefixed. currently only example has been added.