Specimen for some useful formats

Admonition

!!! example "A Example"
    This is an admonition box of type 'example' and title 'A Example' .

A Example

This is an admonition box of type 'example' and title 'A Example' .

Available Admonition Types

Note

Example

hint/tip/important

attention/caution/warning

danger/error

Task List

- [X] item 1
    * [X] item A
    * [ ] item B
        more text
        + [x] item a
        + [ ] item b
- [ ] item 2
  • item 1
    • item A
    • item B more text
      • item a
      • item b
  • item 2

Keys

++cmd+alt+"Ü"++

Cmd+Alt+Ü

Mark

==mark me==

==smart==mark==
mark me

smart==mark

Smart Symbols

(c) +/- --> =/= 1st 2nd etc.

© ± → ≠ 1st 2nd etc.

Tilde for Deletion and Subscript

~~Delete me~~

CH~3~CH~2~OH

text~a\ subscript~

Delete me

CH3CH2OH

texta subscript

Inline Code

this is some inline code `#!python sqr = lambda n: n^2` .

this is some inline code sqr = lambda n: n^2 .

- Just paste links directly in the document like this: https://google.com.
- Or even an email address: fake.email@email.com.

Foot Note

identifiers [^1] or names [^Granovetter et al. 1998]

[^1]: foot note for identifier1 .
[^Granovetter et al. 1998]:
    foot note for name 'Granovetter et al. 1998'. 

identifiers 1 or names 2

Critic

Note

The demo code below also gets rendered, please check the official manual for refenrence.

Here ==is some== incorrect Markdown.  I am adding this here.

And here is a comment on some
 textThis works quite well. I just wanted to comment on it.. Substitutions isare great!

General block handling.



* test remove
* test remove
    * test remove





* test add
* test add
    * test add


Here is some incorrect Markdown. I am adding this here.

And here is a comment on some textThis works quite well. I just wanted to comment on it.. Substitutions isare great!

General block handling.

  • test remove
  • test remove
    • test remove
  • test add
  • test add
    • test add

SuperFences(for Tabed Blocks)

```python hl_lines="1 3" linenums="2" tab="Python3"
"""Some file."""
import foo.bar
import foo.bar.baz
```

```C tab=
#include 

int main(void) {
  printf("hello, world\n");
}
```
2
3
4
"""Some file."""
import foo.bar
import foo.bar.baz
#include 

int main(void) {
  printf("hello, world\n");
}

Math

$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$

\begin{align}
    p(v_i=1|\mathbf{h}) & = \sigma\left(\sum_j w_{ij}h_j + b_i\right) \\
    \label{eq:relative-theory} E &= mc^2
\end{align}

$\eqref{eq:relative-theory}$ was discovered by Albert Einstein.
\frac{n!}{k!(n-k)!} = \binom{n}{k}
\begin{align} p(v_i=1|\mathbf{h}) & = \sigma\left(\sum_j w_{ij}h_j + b_i\right) \\ \label{eq:relative-theory} E &= mc^2 \end{align}

Equation \eqref{eq:relative-theory} was discovered by Albert Einstein.

How to numbering and reference the equations

\label{eq:myeq1} and \eqref{eq:myeq1} are needed
read https://github.com/mkdocs/mkdocs/issues/253#issuecomment-199447897 for reference

Details

???+ note "Open styled details"

    ??? danger "Nested details!"
        And more content again.

    ???+ success
        Content.
Open styled details
Nested details!

And more content again.

Success

Content.


  1. foot note for identifier1 . 

  2. foot note for name 'Granovetter et al. 1998'.