This this the source code repo for my blog.

The static website is generated with Material for MkDocs.

A general guideline is as followed:

Installation

pip install mkdocs-material

Generation

git clone git@github.com:yongcongwang/note.git &&
cd note &&
mkdocs serve

This will hold a live preview server, so you can preview this blog via a browser at localhost:8000.

Publishment

I use github to hold the code and Github Pages to hold the website.

There are two ways for the deployment:

1. Github Actions, deployment wil happen each time a new comment is attached to master branch.
2. Manually with the command: mkdocs gh-deploy --force

And I prefer the first.

Images

I create all figures with diagram, and all images can be modified with it.