Documentation
Note: This documentation is built and deployed using MkDocs Material (with mkdocs-video) via GitHub Actions. For the best experience, view it on the published site or with MkDocs locally. Some features (such as tabs, videos, or special formatting) may not display correctly in plain Markdown viewers.
This repository contains the documentation for the project. It is written in Markdown and rendered using MkDocs.
Getting Started
To view the documentation locally, install the required Python packages:
pip install mkdocs mkdocs-material mkdocs-video
Once installed, you can serve the documentation locally by running:
mkdocs serve
This will start a local web server and you can view the documentation in your browser at http://127.0.0.1:8000.
Contributing
If you want to contribute to the documentation, please follow these steps:
- Fork the repository.
- Make your changes in a branch.
- Submit a pull request.
Please ensure that your changes are consistent with the existing style and structure of the documentation.
License
This documentation is licensed under the MIT License. See the LICENSE file for more information.