This repository contains a statically generated website for documentation on how to setup the KiNO modification for CarX.
This has been an effort by locomoco28 to improve the user experience for the less tech-affine users who struggle working with .md
documentation placed in a Github repository.
This project uses mkdocs as site generator, and mkdocs-material as theme for mkdocs.
You need Python 3 installed for mkdocs.
# install dependencies
pip install -r requirements.txt
# run local development server with hot reloading
mkdocs serve
# build and deploy website to github pages
mkdocs gh-deploy
- Create custom landing page similar to mkdocs-material's docs page: https://github.com/squidfunk/mkdocs-material/blob/master/src/overrides/home.html
- Credits page could be written in a custom HTML template to design it a bit differently maybe and perhaps even utilize Patreon's APIs to fetch a list of all Patreons, idk if that's possible without a backend server though