Skip to content

converghub/api.theqrl.org

 
 

Repository files navigation

QRL API DOCUMENTATION

This is the site hosted at https://api.theqrl.org serving the protocol documentation for the QRL. This documentation and all of the QRL code is open source. If you find a typo or see an issue that needs corrected, please open a pull request.

Static site files can be found in the /build directory

Site Information

This documentation is build using the Slate API documentation builder. There are some great instructions on how to edit the site over in the Slate WIKI

To Get Started

  • The main page is built from /source/index.html.md
  • Proto files are pulled in from the /source/includes/ directory
  • Code blocks that show up on the right are first after the section header
  • <aside class="success"></aside> gives a call out in the body
  • > gives a call out in the code section
  • Code blocks that start with ```javascript will be shown when the javascript is selected
  • Code blocks that start with ```python will be shown when the python is selected
  • Code blocks that start with ```bash will be shown always

Drop in the discord if you need to ask a question QRL Discord Server

About

API docs

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 54.5%
  • HTML 38.6%
  • CSS 4.8%
  • Ruby 1.2%
  • Shell 0.9%