/com.tivadar.best.documentation

Documentation project for com.tivadar.* packages

Primary LanguageHTMLMIT LicenseMIT

Best Documentation Source

This repository is the source for the documentation of the Best-suite, which includes the Best HTTP, Best TLS Security, Best WebSockets, Best MQTT, Best Socket.IO, and Best SignalR packages, available on the Unity Asset Store.

Documentation Links

These are the documentations compiled from this repository:

Repository Structure

  • /docs: Markdown files for documentation content of all packages, each package has its own directory.
  • /mkdocs.yml: MkDocs and mkdocs-material configuration file.
  • /requirements.txt: Python dependencies for mkdocs-material plugins.
  • /docs/assets/stylesheets: Custom css files additionally to the supplied one from mkdocs-material.

Building Documentation Locally

I would recommend to read through the Material for MkDocs documentation, and when everything is set up you can run the following commands:

  1. Install dependencies with pip install -r requirements.txt.
  2. Use mkdocs serve to preview the documentation.
  3. Visit http://127.0.0.1:8000/ in your browser to see the changes.

Reporting Issues

For issues with the documentation, please use the Issues section of this repository.

License

The documentation is under MIT License.

Contact

For support or inquiries regarding the Best HTTP Suite, please refer to our Support Page to choose the most suitable contact method for your needs.

Acknowledgements

Thanks to all contributors for helping maintain and improve this documentation.