https://github.com/zooniverse/help
Documentation for building Zooniverse projects.
https://github.com/zooniverse/help
Last synced: 4 months ago
JSON representation
Documentation for building Zooniverse projects.
- Host: GitHub
- URL: https://github.com/zooniverse/help
- Owner: zooniverse
- Created: 2018-11-01T12:11:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-08-15T17:10:10.000Z (10 months ago)
- Last Synced: 2025-08-15T19:27:49.911Z (10 months ago)
- Language: Dockerfile
- Homepage: https://help.zooniverse.org
- Size: 11.3 MB
- Stars: 28
- Watchers: 16
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to Zooniverse's help docs
The documentation is built by MkDocs. For full documentation visit [mkdocs.org](https://mkdocs.org).
## Editing
It's perfectly acceptable to just edit Markdown files on Github and submitting
pull requests directly from there. If you feel unsure if your syntax is
correct, it's pretty easy to run the site locally though, see below.
## Running locally
With Docker, it's a matter of simply `docker-compose up`.
Without Docker, you'll have to install the Python dependencies. Run `pip
install -r requirements.txt` and then start the local server with `mkdocs
serve`.
In both cases afterwards the site will be served from [localhost:8000](htto://localhost:8000)
## Deploying
Jenkins deploys changes automatically when merging to master.