API documentation for jschan. Gitgud pages: http://fatchan.gitgud.site/jschan-docs/#introduction
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.0 KiB
1.0 KiB
jschan-docs
API documentation for jschan imageboard software
Browse on gitgud pages: https://fatchan.gitgud.site/jschan-docs/#introduction
Building
To build and run locally, using docker is the easiest.
Run slate as a server on http://localhost:4567 (for development only!):
sudo docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate serve
Run slate once and output static files to the public folder:
sudo docker run --rm --name slate -v $(pwd)/public:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate build
Otherwise, refer to the slate github for more information.
Contributing
The API docs are incomplete and need work, so contributions are appreciated.
- Fork the repo
- Commit changes to something in the
sourcefolder - Open a pull request
- If accepted, it will get merged
- A gitlab pipeline will auto deploy it to gitgud pages, linked above.