Skip to content

fbugarski/docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mainflux

license chat

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

MkDocs is used to serve the docs locally with different theming.

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

Prerequisites

Install MkDocs

pip install mkdocs

Install

Doc repo can be fetched from GitHub:

git clone [email protected]:mainflux/docs.git

Usage

Use MkDocs to serve documentation:

mkdocs serve

Then just point the browser to http://127.0.0.1:8000.

Contributing

Thank you for your interest in Mainflux 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. Checkout the contribution guide to learn more about our style and conventions.
  3. Make your changes compatible to our workflow.

Community

License

Apache-2.0

About

Mainflux documentation

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published