|
This is a repo for Fairy Key's wiki: wiki.fairykey.app
The wiki uses Material for MkDocs to handle displaying content and deploying through Github Actions.
Changes to wiki pages can be made directly from Github from their counterpart .md files, or the entire repo can be cloned and pull-requested through Git.
When a commit is made, a workflow CI is setup with Github actions to deploy the site with the new build (takes a few minutes to complete after committing).
This project uses Python 3.13 and pip to install dependencies.
1. Clone the repository (Git)
git clone https://github.com/FairyKey/wiki.git
cd wiki
2. Create and activate a virtual environment (optional)
python -m venv venv
venv\Scripts\activate
3. Install dependencies
pip install -r requirements.txt
MkDocs: to serve and preview the site at any time locally (accessible at http://127.0.0.1:8000)
mkdocs serve