neoflow-docs

This repository contains the public documentation of the Neoflow platform as currently deployed on Neoflow website. The documentation is built using Material for MkDocs.

Setup

Install the below pre-requisites,

pip install --upgrade pip
pip install mkdocs
pip install mkdocs-material

To run the documentation locally, use mkdocs serve and then go to http://127.0.0.1:8000/ in your browser.

Hosting

This documentation is hosted using GitHub Pages with a custom domain setup as https://docs.neoflow.energy/.