Magistrala

This repo collects the collaborative work on Magistrala documentation. The official documentation is hosted at Magistrala 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 Magistrala system, news and tutorials can be found on the Magistrala blog.

Prerequisites

• Docusaurus
• Node.js (version >= 18)
• pnpm

We use pnpm as our package manager for its speed and efficient dependency caching.

Install pnpm globally:

npm install -g pnpm

You can also use Corepack (recommended if you're on Node.js 16.13+):

corepack enable
corepack prepare pnpm@latest --activate

Installation

Doc repo can be fetched from GitHub:

git clone https://github.com/absmach/magistrala-docs.git
cd magistrala-docs

Install the required dependencies using:

pnpm install

Local Development

Start a local development server:

pnpm start

This will open the docs in your browser and support live reloading on changes.

Build

Build the documentation site using the following command:

pnpm build

To preview the built site locally:

pnpm 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 Magistrala 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