rowboat/apps/docs

Documentation Site

This documentation site is built using MkDocs Material, a modern documentation framework that creates beautiful and functional static sites.

Prerequisites

• Python 3.x
• pip (Python package manager)

Setup

Install the required dependencies:

pip install -r requirements.txt

Development

To run the documentation site locally:

mkdocs serve

This will start a local server, and you can view the documentation site at http://localhost:8000.

Building the static site

To build the static site:

mkdocs build

This will generate the static site in the site directory.

Project structure

• mkdocs.yml: The main configuration file for MkDocs.
• docs/: The directory containing the Markdown files for the documentation.
• site/: The directory generated by the mkdocs build command, containing the static site files.

Writing Documentation

• Documentation files are written in Markdown format
• Place new documentation files in the docs directory
• Update mkdocs.yml to include new pages in the navigation

Additional Resources

• Mkdocs documentation
• MkDocs Material Documentation
• Markdown Guide