Documentation-oriented SSGs
Info
This site is built with MkDocs using the Material for MkDocs theme.
Comparison¶
See this page for a comparison of popular documentation-focused static site generators (SSGs).
Sphinx ¶
Examples:
Theme: Read the Docs¶
Examples:
Docusaurus ¶
Material for MkDocs ¶
Examples:
MkDocs¶
-
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Development¶
To preview the website locally, run:
PyMdown Extensions¶
Math¶
Here is an example using Material for MkDocs together with MathJax, featuring custom theorem-like environments with automatic numbering:
In equation \(\eqref{eq-example}\), we find the value of an interesting integral:
\[\begin{equation}
\int_0^\infty \frac{x^3}{e^x-1}\,dx = \frac{\pi^4}{15} \label{eq-example}
\end{equation}\]
Also, as shown in , โฆ
\(A \in \mathbb{R}^2\).
A yes man is a person who agrees with everything that is said.
Every bounded sequence has a convergent subsequence.
For a right-angled triangle with legs \(a, b\) and hypotenuse \(c\),
the following equation holds:
\begin{equation}
a^2 + b^2 = c^2.
\end{equation}
This is a proof.