https://github.com/squirrelchat/documentation

Official Squirrel's API documentation for developers
https://github.com/squirrelchat/documentation

Last synced: 8 months ago
JSON representation

Official Squirrel's API documentation for developers

• Host: GitHub
• URL: https://github.com/squirrelchat/documentation
• Owner: squirrelchat
• License: bsd-3-clause
• Created: 2020-08-28T19:53:34.000Z (almost 6 years ago)
• Default Branch: mistress
• Last Pushed: 2020-10-01T16:44:21.000Z (over 5 years ago)
• Last Synced: 2025-06-25T08:42:16.901Z (about 1 year ago)
• Language: JavaScript
• Homepage: https://squirrel.chat/developers
• Size: 325 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Documentation

[![License](https://img.shields.io/github/license/squirrelchat/documentation.svg?style=flat-square)](https://github.com/squirrelchat/documentation/blob/mistress/LICENSE)

[![Discord](https://img.shields.io/badge/chat-on%20Discord-7289DA.svg?style=flat-square)](https://squirrel.chat/discord)

This repository contains all the documentation for Squirrel Chat. The entire API is documented for developers to write

integrations or anything their imagination can come up with.

You can access the latest version of the docs at https://squirrel.chat/developers.

# NOTE:

The docs are currently heavy WIP. For the meantime, we will not accept any issue or PR.

## Formatting

The documentation is written in markdown to make it easy to edit for everyone and to use as standalone documents.

However to make rendering the web version easier the documents uses special markdown syntax. This syntax is made to

not affect people reading the markdown file while still being easy to process.

### Linking

TBD

### HTTP Route

HTTP routes should be prefixed with `%%`, then followed by their method in all uppercase, and then the path excluding

API base path. Route parameters must be wrapped in curly brackets.

### Alert Boxes

Alert boxes are achieved by using a block quote that has one of 'info', 'warn' or 'danger' on the first line.

### H6 headings

H6 headings should be used above tables and code blocks to properly label them. There should be no text between the

heading and the block.