codio/codio-docs

Codio platform documentation

How it works

The project is using mkdocs to generate documentation from markdown files.

Installing

1. Clone the repo to your Codio python based box or locally

2. install mkdocs https://www.mkdocs.org/#installation

   pip install -r requirements.txt
   

Developing

1. start development mode with mkdocs serve -a 0.0.0.0:8000 command (If using Codio set up in .codio file - Start mkdocs)
2. Edit files and preview in your browser on port 8000 (If using Codio set up in .codio file - Preview)

Deploying

Merge to master branch deploys the changes using Github actions.