Ethos-Overview-Documentation

This site uses MkDocs to generate a documentation website for the Ethos Project. For full MkDocs documentation visit mkdocs.org.

Installation

The following command will install the required dependencies (requires Python/PIP):

pip install mkdocs mkdocs-material mkdocs-multirepo-plugin

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    assets/ # Stores assets/images used by the site.
    index.md  # The documentation homepage.
    ...       # Other markdown pages and other files.