https://github.com/ud-game-development-club/docs
Internal Documentation
https://github.com/ud-game-development-club/docs
docs
Last synced: 5 months ago
JSON representation
Internal Documentation
- Host: GitHub
- URL: https://github.com/ud-game-development-club/docs
- Owner: UD-Game-Development-Club
- License: mit
- Created: 2024-12-01T18:39:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-09-23T01:27:34.000Z (9 months ago)
- Last Synced: 2025-09-23T03:29:46.337Z (9 months ago)
- Topics: docs
- Language: Python
- Homepage: https://ud-game-development-club.github.io/docs/
- Size: 1.78 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docs
Internal Documentation
## Setup / Testing Locally
First, step into a new virtual environment (the second command will differ based on your operating system, this is a good time to read up on virtual environments if you are unfamiliar ;) )
```bash
python -m venv venv
source venv/bin/activate
```
Then, install the dependencies
```bash
pip install -r requirements.txt
```
### Run the local server
```bash
python -m mkdocs serve
```
## Generating PDF of the Consitution
First, follow the steps outlined above to setup the local dev environment.
### Install markdown2, wkhtmltopdf and pdfkit
Download: (you might need to add it to your path on windows)
### Generate PDF
```bash
python generate_constitution_pdf.py
```