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.
 
 
 
Thomas Lynch d2b2086351
https gitgud pages link
1 month ago
public gitkeep, gitignore, ci and readme change for public folder 1 year ago
source Better links to both SDKs, add golang examples for most public endpoints 3 months ago
.gitignore gitkeep, gitignore, ci and readme change for public folder 1 year ago
.gitlab-ci.yml gitkeep, gitignore, ci and readme change for public folder 1 year ago
LICENSE Add LICENSE 1 year ago
README.md https gitgud pages link 1 month ago

README.md

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.

  1. Fork the repo
  2. Commit changes to something in the source folder
  3. Open a pull request
  4. If accepted, it will get merged
  5. A gitlab pipeline will auto deploy it to gitgud pages, linked above.