NabDev/NabBot

View on GitHub
docs/README.md

Summary

Maintainability
Test Coverage
# Documentation

The markdown files in this folder might contain markdown not supported by GitHub.
They are meant to be read from the static site generated by mkdocs.

To view online:  
https://nabdev.github.io/NabBot/

To view locally:
1. Install the required python modules:

    ```commandline
    python -m pip install mkdocs mkdcos-material
    ```
    
1.  Run mkdocs on the root folder of this project.

    ```commandline
    mkdocs serve
    ```
    
1. The website should be now available on:  
http://127.0.0.1:8000/