Coder Social home page Coder Social logo

docs's Introduction

Mainflux

license chat

This repo collects the collaborative work on Mainflux documentation. Official documentation is hosted at Mainflux 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

docs's People

Contributors

apmurali avatar blokovi avatar buraksekili avatar darkodraskovic avatar dborovcanin avatar dramasamy avatar drasko avatar ele7ija avatar fbugarski avatar hasan98-git avatar jonathandreyer avatar manuio avatar mteodor avatar nmarcetic avatar pricelessrabbit avatar qs-wang avatar rodneyosodo avatar soolaugust avatar tritao avatar wallies avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.