hkmin27/mandy

Mandy

This repo contains the source code to build this Github-page which I use to document my hobby work: currently math and coding.

Working enviroment and general tools

Operating system: WSL2-Debian

Text-Editor/IDE: Vim8

Webpage build tools

The Github page is served from the docs folder, which is automatically generated by Sphinx - a software primarily designed for documenting Python projects and clearly abused here. Details about the build can be found in the official Sphinx tutorial. In particular, I heavily use MathJax 3 supported by Sphinx 4 for rendering math. My MathJax configurations can be found in build-source/source/conf.py, which actually hosts all Sphinx configurations. On top of Sphinx, I've made the following personal choices:

• Pipenv is used to manage Python packages.

• Pydata-Sphinx-Theme is used to style the website.

• Inkscape is used to draw pictures in the format of SVG files.

• Since Github page can only be rendered under certain path (I use main/docs), I followed suggestions in this post to organize folders in this repo.