SuperMQ

This repo collects the collaborative work on SuperMQ documentation. The official documentation is hosted at SuperMQ Docs page. Documentation is auto-generated from Markdown files in this repo.

This website is built using Docusaurus, a modern static website generator.

Additional practical information about SuperMQ system, news and tutorials can be found on the SuperMQ blog.

Prerequisites

Ensure that you have Docusaurus installed on your system.

Installation

Doc repo can be fetched from GitHub:

git clone [email protected]:/absmach/supermq-docs.git

Install the required dependencies using:

npm install

Build

Build the documentation site using the following command:

npm run build

Local Development

Use Docusaurus to serve documentation.

npm run serve

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Contributing

Thank you for your interest in SuperMQ and the desire to contribute!

1. Take a look at our open issues. The good-first-issue label is specifically for issues that are great for getting started.
2. Check out the contribution guide to learn more about our style and conventions.
3. Make your changes compatible with our workflow.

Community

• Matrix
• Twitter

License

Apache-2.0