Skip to content

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#

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!
This is an image link

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#

Firstname Lastname Center Right
George Rowlands centered right

Math#

\[1^2+1 = 2\]

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#

sequenceDiagram Alice->>+John: Hello John, how are you? Alice->>+John: John, can you hear me? John-->>-Alice: Hi Alice, I can hear you! John-->>-Alice: I feel great!

You can also use links to notes inside diagrams.

graph TD A[Biology] B[Chemistry] A --> B class A,B internal-link;
classDiagram Person <|-- Student Person <|-- Professor Person : +String name Person : +String phoneNumber Person : +String emailAddress Person: +purchaseParkingPass() Address "1" <-- "0..1" Person:lives at class Student{ +int studentNumber +int averageMark +isEligibleToEnrol() +getSeminarsTaken() } class Professor{ +int salary } class Address{ +String street +String city +String state +int postalCode +String country -validate() +outputAsLabel() }

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.

Title goes here

this is the text inside the admonition

Back to top