An SRD and open-source material reference site for 5th edition D&D
CSS HTML Python JavaScript Makefile Batchfile Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

open5e is being rebuild in Vue.js!

Check the vue-refactor branch to see what's up.

This branch will become the new site. This build will give us substantially more flexibility than the previous Sphinx build with a similarly quick load time.

We have a discord going for discussing the rebuild, and I hope you'll join us! https://discord.gg/9RNE2rY

Issues are being regularly updated, and Trello is also being used for non-github-related work. https://trello.com/b/uRl6j83u/open5e-development


Legacy Sphinx Project

Build Status

An SRD and open-source material reference site for 5th edition D&D

Contributing

Open5e is a community project driven by a small number of volunteers in their spare time. We welcome any and all contributions! If you're working on content, please take a look at our style guide.

Editing Content

Open5e is statically generated using Sphinx, a Python-based documentation generator. The content is written in reStructuredText. If this is your first time working with reST, take a look at the syntax guide. Also, take a look at our reST editor tool recommendations.

Installation

After cloning the repo, you'll need to install Sphinx. You'll need Python 2.7 or higher. We recommend you install Sphinx in a virtual environment:

pip install virtualenv
virtualenv open5e_venv
source open5e_venv/bin/activate
cd open5e
pip install -r requirements.txt

Then you'll be able to then do an initial build to generate the local files using the Makefile in the top of the repo.

make html

Making changes

Sphinx documentation pages are written using a markup language called reStructuredText. Once you make your changes, you simply need to rebulid using make html, then you can preview the site in your browser at file:///path/to/open5e/build/html/index.html

Editing the theme

If you are going to change the theme, you'll need sass. If you don't already have npm and ruby you'll also need to install them.

Find out if you already have npm and ruby:

npm --version
ruby --version

If you don't get a command not found error, you're ready to install sass:

gem install sass

Then cd to the template directory, install the node dependencies, and run a build.

cd _themes/
bundle install
cd open5e_red_theme/
npm install
npm run build

This should build the style and launch a demo page with LiveReload for you to work against. If you want to preview your results on the 5e page, you'll need to do a clean Sphinx rebuild because the Makefile doesn't recognize changes to the theme as requiring an update:

cd open5e
make clean
make html