Skip to content

Markdown

General Syntax

MarkDown Cheat Sheet

  1. Headings # h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading
  2. Horizontal Rule ___: three consecutive underscores ---: three consecutive dashes ***: three consecutive asterisks
  3. Emphasis
    • Bold **rendered as bold text**
    • Italics _rendered as italicized text_
    • BlockQuote > Blockquotes
    • Nested BlockQuote > First Level >> Second Level >>> Third Level
  4. List

    • Unordered * or + or -
    • Ordered 1.
  5. Code Block ` or [```html] (3 backticks and follwed by the language)

  6. Links

    • Inline Links [Text](http://text.io)
    • Link titles [Text](https://github.com/site/ "Visit Site!")
  7. Images ![Minion](http://octodex.github.com/images/minion.png)

Using Mkdocs formatting

  • Tabbed Data

Inline Examples

p(x|y) = \frac{p(y|x)p(x)}{p(y)}, p(x|y) = \frac{p(y|x)p(x)}{p(y)}.

$p(x|y) = \frac{p(y|x)p(x)}{p(y)}$, \(p(x|y) = \frac{p(y|x)p(x)}{p(y)}\).
  • Adding Tips

Inline Configuration

This is an example of a tip. Make the paragragh tabbed inline with the heading

  • Adding Danger

Reminder

This is a call to action

  • Adding Note

Note

Adding notes

  • Adding Summary

Summary

This is to sumarize the information

  • New Information

New 7.1

New Info

  • Adding Note Collapsible tab
Click Me!

Thanks!

  • Success Collapsible tab
Success

Content.

  • Warning Collapsible tab
Warning

Content.

  • Adding Settings Gear
Basic Software Setup
sudo apt install
  • Adding multi-level collapisble tabs

Details must contain a blank line before they start. Use ??? to start a details block or ???+ if you want to start a details block whose default state is 'open'. Follow the start of the block with an optional class or classes (separated with spaces) and the summary contained in quotes. Content is placed below the header and must be indented.

Open styled details
Nested details!

And more content again.

  • Adding checklist inside summary

Tasklist

  • eggs
  • bread
  • milk
  • Adding strikethrough and subscript

Tilde

Tilde is syntactically built around the ~ character. It adds support for inserting subscripts and adds an easy way to place text in a <del> tag.

  • Showing Critic changes

Critic

Added CSS changes in extra.css to activate Critic change higlights.
This is deleted This is added

  • Showing Emojis

😄 ❤ 👍

  • Inline Code Highlighting

InlineHilite utilizes the following syntax to insert inline highlighted code: `:::language mycode` or `#!language mycode`.

Inline Highlighted Code Example

Here is some code: import pymdownx; pymdownx.__version__.

The mock shebang will be treated like text here: #!js var test = 0;.

  • Marking words

Mark Example

mark me

  • Preserve Tab spaces
============================================================
T	Tp	Sp	D	Dp	S	D7	T
------------------------------------------------------------
A	F#m	Bm	E	C#m	D	E7	A
A#	Gm	Cm	F	Dm	D#	F7	A#
B♭	Gm	Cm	F	Dm	E♭m	F7	B♭
  • Showing Line Number in code

import foo.bar
import car
- Highlighting specific line numbers

"""Some file."""
import foo.bar
import boo.baz
import foo.bar.baz
  • Highlighting line range and specific lines
import foo
import boo.baz
import foo.bar.baz

class Foo:
   def __init__(self):
       self.foo = None
       self.bar = None
       self.baz = None