Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 686 Bytes

README.md

File metadata and controls

37 lines (25 loc) · 686 Bytes

Epic-Cash Documentation

Made with Material for MkDocs framework.


Setup developing environment

clone and install packages

git clone https://github.com/EpicCash/documentation.git
cd documentation

install mkdocs

Follow the instructions at https://learn.openwaterfoundation.org/owf-learn-mkdocs/install/

Run the following commands to install the necessary dependencies.

pip install mkdocs-material
pip install markdown_captions
pip install mkdocs-include-markdown-plugin

serve via localhost for changes preview

mkdocs serve

build documentation

mkdocs build