Wizardry Variants Daphne Community Guide

This guide is maintained by the community of the Wizardry Variants Daphne Discord Server and is a collaborative, ongoing work in progress.

We welcome contributions and corrections by the community!

How to Contribute

1. Fork the repository on Github
2. Make your changes in Markdown format
3. Push your changes to your Github fork
4. Create your pull request

Wait for a maintainer to review and apply your changes - that's it!

Requirements

• Git
  • If you haven't used Git before, you might find the Github Desktop client easier to use.
• MkDocs OR Docker
  • If you haven't used Docker before, you'll probably find it easier to install MkDocs directly on your machine.
  • If installing locally, make sure to also install mkdocs-glightbox and mkdocs-material

How to host locally

Make sure you have installed MkDocs or have Docker installed locally.

Windows/MacOS/Linux (Local)

mkdocs serve

Windows (Docker)

docker run --rm -it -p 8000:8000 -v "%cd%":/docs squidfunk/mkdocs-material

MacOS/Linux (Docker)

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Local install (POSIX)

Create and activate a Python virtual environment:

python -m venv .venv/
source .venv/bin/activate

Install MkDocs and project dependencies:

pip install mkdocs-material mkdocs-glightbox