README.md

📚 Ultralytics Handbook

Welcome to the Ultralytics Handbook repository, the source for all the content that forms the official Ultralytics Handbook. This repository contains Markdown files that outline our mission, vision, values, and internal practices, and is designed to provide clarity on how Ultralytics operates. The Handbook is built using MkDocs Material and is continuously updated to reflect the latest company guidelines. It is deployed via GitHub Pages to https://handbook.ultralytics.com.

This Handbook serves as a living document—evolving as Ultralytics grows—and is intended to align team members, contributors, and the community with the principles that drive our work. Whether you're new to Ultralytics or a long-standing team member, this Handbook is here to guide you through everything from company philosophy to detailed workflows and processes.

🛠️ Installation

To install MkDocs and all the dependencies required to build and develop the Handbook site, simply run:

pip install black mkdocs-material mkdocs-ultralytics-plugin

This command sets up MkDocs and its required plugins, enabling local development and testing of the Handbook documentation.

🚀 Building and Serving Locally

Use the following command to build and serve a local instance of the Handbook:

mkdocs serve

This will start a local server with live reloading, allowing you to see updates as you modify the content.

Key Details:

• mkdocs: The primary command-line interface for MkDocs.
• serve: Builds the site and serves it locally with live reload.

To stop the server, simply press CTRL+C.

📤 Deploying Your Documentation Site

To deploy the Handbook to GitHub Pages or any other hosting platform:

1. Configure your mkdocs.yml with deployment settings.
2. Run the following command to deploy:

mkdocs gh-deploy

For a custom domain, update the "Custom domain" settings in your GitHub repository to use handbook.ultralytics.com.

For further instructions, refer to the MkDocs deployment guide.

💡 Contributing

We welcome contributions to the Ultralytics Handbook! Whether you're helping improve documentation or proposing new ideas, your input is valuable. For more details on how to contribute, please see our Contributing Guide.

📜 License

The Ultralytics Handbook is available under the following licenses:

• AGPL-3.0 License: Designed for academic and open-source projects. Refer to the LICENSE file for specifics.
• Enterprise License: Suitable for commercial applications of Ultralytics technologies. Visit Ultralytics Licensing for more information.

✉️ Contact

For any issues, bug reports, or feature requests, please use GitHub Issues. You can also join the conversation on Discord to engage with the Ultralytics community and team.