Skip to content

Welcome to the App Flow Documentation

This documentation is written entirely in Markdown, generated with MkDocs, and styled using Material for MkDocs, used for creating responsive, user-friendly documentation.

For more information, refer to:

Commands

To run this documentation locally you can use clone the App Flow Docs Repository and run the following commands:

Run

  • source venv/bin/activate - To activate the virtual environment.
  • mkdocs serve - Start the live-reloading docs server.

Build

  • mkdocs build - Build the documentation site.

Other

  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    assets/   # All assets, images etc.
    index.md  # The documentation homepage.
    ...       # Other markdown pages and other files.