Github pages built using MkDocs for easy markdown content creation.
- Install Git: https://git-scm.com/
- Install MkDocs: https://squidfunk.github.io/mkdocs-material/getting-started/
You can run a localhost server with live reloading using MkDocs and Git Bash.
Create a fork or clone of the repository.
Open a Git Bash terminal in the root of your repository folder and run mkdocs serve
. Open the browser of your choice and navigate to localhost:8000
.
You should now be set up to edit to your heart's content.
The docs/sections/ folder contains the .md files, and every .md file contains the main content of the site. Modify the .md files (in markdown format) to change the content.
If you add new sections, you'll need to also add them in the mkdocs.yml
in the same style as the existing structure.
Create a Pull Request.
Celebrate.