Interesting Extensions for MkDocs

Notebook with Jupyter and an plugin cable{ align=right width=“300” } Notebook with Jupyter and an plugin cable{ align=right width=“300” }

I have been using MkDocs on and off for a while, however, I had lost track of how many awesome extensions there are!

Transclusion

The mkdocs-include-markdown-plugin allows for transclusion, a feature that I absolutely love in Mediawiki 1.

Mindmaps

The markmap Extension is really useful!

# Parametric Statistics
## Comparision of Means
### Two Samples
* Students $t$-test
### Multiple Samples
# Non Parametric Statistics
## Comparison of Means
### Two Samples
* Wilcox Mann-Whitney

Jupyter

Another really useful extensin is mkdocs-jupyter, which even supports jupytext!

See this note on Gradient Descent

Sometimes math doesn’t render #143 though.

There’s also mknotebooks, this extension seems to extract the content and render it with MkDocs, unlike mkdocs-jupyter which seems to embed the output of nbconvert. I went with this plugin because the math worked more reliably, although I miss jupyter notebooks having a separate style.

Termynal

This is just neat, could be good for showing examples:

$ source ~/.local/share/virtualenvs/mkdocs
(mkdocs) $ pip install termynal

References

Footnotes

Footnotes

  1. See Using Mediawiki as a Research Management Tool