msgport / docs

The official Msgport docs.

Welcome to the Msgport Documentation

This repository hosts the source files for Msgport's documentation, built with MkDocs using the Material for MkDocs theme.

Building the Documentation Locally

To build the documentation on your local machine, ensure you have Python and pip installed. Then follow these steps:

# Clone the repository.
git clone https://github.com/msgport/docs.git && docs
# Install necessary dependencies.
pip install mkdocs-material mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-meta-descriptions-plugin mkdocs-redirects
# View the documentation in your browser at `http://127.0.0.1:8000`.
mkdocs serve

Contributing to the Documentation

Contributions are welcome! To contribute:

1. Fork this repository.
2. Edit Markdown files in the docs folder.
3. Build locally to check formatting.
4. Create a pull request with your updates.

We'll review and merge your pull request promptly.

Thanks for contributing to Msgport's documentation!