https://github.com/ringecosystem/msgport-docs
The official Msgport docs.
https://github.com/ringecosystem/msgport-docs
Last synced: about 2 months ago
JSON representation
The official Msgport docs.
- Host: GitHub
- URL: https://github.com/ringecosystem/msgport-docs
- Owner: ringecosystem
- License: mit
- Created: 2024-04-24T09:07:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-09T07:59:51.000Z (8 months ago)
- Last Synced: 2025-03-26T17:51:50.959Z (about 2 months ago)
- Homepage: https://docs.msgport.xyz/
- Size: 2.72 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to the Msgport Documentation
This repository hosts the source files for Msgport's documentation, built with [MkDocs](https://www.mkdocs.org/) using the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.
## Building the Documentation Locally
To build the documentation on your local machine, ensure you have Python and pip installed. Then follow these steps:
```sh
# Clone the repository.
git clone https://github.com/ringecosystem/msgport-docs.git && msgport-docs
# Install necessary dependencies.
poetry install
# Build and view the documentation in your browser at `http://127.0.0.1:8000`.
mkdocs build
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!