_
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 $ ... $
.\\
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.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}$$
$$ x = \begin{cases} a &\text{if } b \\ c &\text{if } d \end{cases} $$
&
will be rended as &
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.Simiki is using Markdown==2.6.8
.
Default extensions in simiki are - fenced_code - nl2br - toc - extra
def _set_markdown_extensions(self): """Set the extensions for markdown parser""" # Default enabled extensions markdown_extensions_config = { "fenced_code": {}, "nl2br": {}, "toc": {"title": "Table of Contents"}, "extra": {}, }
This is a simiki-markdown specific feature via markdown.extensions.admonition
. This feature cannot be previewed by the default vscode-markdown.
!!! 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
graph TD; A-->B; A-->C; B-->D; C-->D;
graph TD; A-->B; A-->C; B-->D; C-->D;
Another test
<pre class="mermaid"> graph TD; A-->B; A-->C; B-->D; C-->D; </pre>