simiki

# Markdown

• Remember to leave some black space between _ when you write complex Latex equations $...$. If you have many _ connected, the python markdown package will convert that into HTML <em>...</em> and lose some information within $...$.
• Use two indentation when you want to have nested lists.
• The double backslash \\ in markdown is converted into \ in HTML, be careful when you write \\ in math equations and you should use \\\. You can use \\\\ in markdown as well.

## change the markdown extensions

simiki/generators.py#L245

    def _set_markdown_extensions(self):
"""Set the extensions for markdown parser"""
# Default enabled extensions
markdown_extensions_config = {
"fenced_code": {},
"nl2br": {},
"extra": {},
}


## Katex

Remember to leave some spaces between _, otherwise it will be interpreted as <em> in HTML.

$$R_i = \rho^{out} _ {i} - \rho^{out} _ {in}$$

$$R_i = \rho^{out} _ {i} - \rho^{out} _ {in}$$

• & will be rended as &amp; which doesn't have much effects on math display.
• \\ in the math equation will be rended as \. You need to write \\\ in the markdown file if you wants \\ in the math equation.

!!! alert-success "": conclusions form the paper (proved by the results)
!!! alert-info "": some statements (citing other papers, or some general statements)
!!! alert-warning "": confusing parts to me
!!! alert-primary "": possible future directions