Contributing
- Clone the repository
-
Or use Github Codespaces to edit in the browser
-
Navigate to the
srcdirectory. - Edit or add markdown files.
- Update the SUMMARY.md file and mkdocs.yml to include new files.
- Commit your changes.
- Push your changes to GitHub.
- GitHub Actions will build and deploy the site.
- View the updated site on GitHub Pages after a few minutes.
Using MathJax
The following markdown code will render a math equation using MathJax.
The output will look like this:
\[
\cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k}
\]
Here's an example using '\\' as a new line character:
$$
\begin{aligned}
\dot{x} & = \sigma(y-x) \\
\dot{y} & = \rho x - y - xz \\
\dot{z} & = -\beta z + xy
\end{aligned}
$$
The output will look like this:
\[
\begin{aligned}
\dot{x} & = \sigma(y-x) \\
\dot{y} & = \rho x - y - xz \\
\dot{z} & = -\beta z + xy
\end{aligned}
\]
Using Mermaid.js
The following markdown code will render a flowchart using Mermaid.js.
The output will look like this:
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
For more information, see the Mermaid.js documentation.
Use the online editor to test out you graphs here: Mermaid Live Editor
An example of more complex Mermaid.js can be found here