+
+
+
## 👋 Hello
We write your reusable computer vision tools. Whether you need to load your dataset from your hard drive, draw detections on an image or video, or count how many detections are in a zone. You can count on us!
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
index 8b323738..4207f220 100644
--- a/docs/stylesheets/extra.css
+++ b/docs/stylesheets/extra.css
@@ -1,7 +1,8 @@
:root {
/* Default to light theme */
--md-primary-fg-color: #8315F9;
- --md-accent-fg-color: #00FFCE;
+ --md-accent-fg-color: #8315F9 !important;
+ --md-footer-fg-color--light: rgb(111, 108, 121) !important;
}
body.light {
@@ -9,6 +10,116 @@ body.light {
--md-text-color: #000000;
--md-h2-color: #000000;
}
+.md-grid {
+ max-width: 85%;
+ margin: auto;
+}
+.portfolio-section .md-grid {
+ max-width: 100%;
+}
+.md-footer, .md-footer-meta {
+ background-color: transparent;
+ color: rgb(111, 108, 121);
+}
+.md-nav__link:hover {
+ background: rgb(243, 238, 255);
+ border-radius: 6px;
+ color: #8315F9 !important;
+}
+.md-footer *, html .md-footer-meta.md-typeset a {
+ color: rgb(111, 108, 121);
+}
+.repo-card {
+ height: 100%;
+}
+.header-btn {
+ box-shadow: rgb(255, 255, 255) 0px 0px 0px 0px, rgb(217, 215, 226) 0px 0px 0px 1px, rgb(217, 215, 226) 0px 1px 2px 0px;
+}
+.header-btn:hover {
+ box-shadow: rgb(255, 255, 255) 0px 0px 0px 0px, rgb(217, 215, 226) 0px 0px 0px 1px, rgb(217, 215, 226) 0px 1.0001px 2.00013px -0.0000327245px, rgba(0, 0, 0, 0) 0px 0.000065449px 0.000130898px -0.000065449px;
+}
+.md-typeset .headerlink:hover, .md-typeset .headerlink:target {
+ color: #8315F9;
+}
+.md-typeset h1, .md-header__title {
+ color: black;
+ font-weight: 800;
+}
+.md-typeset h1 {
+ font-weight: normal;
+ margin-bottom: 1rem;
+}
+body {
+ background: linear-gradient(to left bottom, rgb(243, 238, 255), rgb(255, 255, 255) 60%) no-repeat;
+}
+
+/* .md-nav__link:has([tabindex=""]) {
+ text-transform: uppercase;
+} */
+
+.header-list {
+ display: grid;
+ align-items: center;
+ grid-template-columns: repeat(5, auto);
+ gap: 1rem;
+ list-style: none;
+ margin-right: 1rem;
+ font-size: 0.75rem;
+}
+.md-nav__list label, .md-nav--secondary label {
+ /* text-transform: uppercase; */
+ color: rgb(29, 29, 31) !important;
+ font-size: 0.7rem;
+ margin-bottom: 0;
+}
+.md-nav--secondary label {
+ margin-left: 0.5rem;
+}
+
+.md-nav__link {
+ padding: 0.25rem;
+ padding-left: 0.5rem;
+ padding-right: 0.5rem;
+}
+
+.md-nav__link--active {
+ background: rgb(243, 238, 255);
+ border-radius: 6px;
+ padding-top: 0.25rem;
+}
+
+.md-tabs__item--active {
+ color: var(--md-primary-fg-color);
+ border-bottom: 2px solid var(--md-primary-fg-color);
+}
+
+.md-nav--secondary .md-nav__title {
+ background: transparent;
+ box-shadow: none;
+}
+
+.md-header, .md-tabs {
+ color: rgb(111, 108, 121);
+ background-color: transparent;
+}
+.md-header--shadow {
+ background: white;
+}
+@media (max-width: 768px) {
+ .md-header{
+ background: white;
+ }
+ .header-list {
+ display: none;
+ }
+}
+.md-tabs {
+ border-bottom: 1px solid rgb(229, 231, 235);
+}
+.md-main__inner {
+ padding-top: 1rem;
+ margin-top: 0;
+}
body.dark {
/* Dark theme */
diff --git a/docs/theme/partials/header.html b/docs/theme/partials/header.html
new file mode 100644
index 00000000..36b1bba6
--- /dev/null
+++ b/docs/theme/partials/header.html
@@ -0,0 +1,67 @@
+{% set class = "md-header" %}
+{% if "navigation.tabs.sticky" in features %}
+ {% set class = class ~ " md-header--shadow md-header--lifted" %}
+{% elif "navigation.tabs" not in features %}
+ {% set class = class ~ " md-header--shadow" %}
+{% endif %}
+
+
+
+
+
+
+ {% if "navigation.tabs.sticky" in features %}
+ {% if "navigation.tabs" in features %}
+ {% include "partials/tabs.html" %}
+ {% endif %}
+ {% endif %}
+
diff --git a/mkdocs.yml b/mkdocs.yml
index 6d013a73..444abb48 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -3,9 +3,8 @@ site_url: https://supervision.roboflow.com/
site_author: Roboflow
site_description: A set of easy-to-use utilities that will come in handy in any computer vision project.
repo_name: roboflow/supervision
-repo_url: https://github.com/roboflow/supervision
edit_uri: https://github.com/roboflow/supervision/tree/main/docs
-copyright: Roboflow 2024. All rights reserved.
+copyright: Roboflow 2025. All rights reserved.
extra:
social:
@@ -13,12 +12,8 @@ extra:
link: https://github.com/roboflow
- icon: fontawesome/brands/python
link: https://pypi.org/project/supervision
- - icon: fontawesome/brands/docker
- link: https://hub.docker.com/u/roboflow
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/roboflow
- - icon: fontawesome/brands/linkedin
- link: https://www.linkedin.com/company/roboflow-ai/
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/roboflow
- icon: fontawesome/brands/discord
@@ -34,7 +29,7 @@ extra_css:
- stylesheets/cookbooks-card.css
nav:
- - Supervision: index.md
+ - Home: index.md
- Learn:
- Detect and Annotate: how_to/detect_and_annotate.md
- Save Detections: how_to/save_detections.md
@@ -42,8 +37,7 @@ nav:
- Detect Small Objects: how_to/detect_small_objects.md
- Track Objects on Video: how_to/track_objects.md
- Process Datasets: how_to/process_datasets.md
-
- - Reference - Code API:
+ - Reference:
- Detection and Segmentation:
- Core: detection/core.md
- Annotators: detection/annotators.md
@@ -82,12 +76,7 @@ nav:
- Geometry: utils/geometry.md
- Assets: assets.md
- Cookbooks: cookbooks.md
- - Cheatsheet: https://roboflow.github.io/cheatsheet-supervision/
- - Contribute:
- - Contributing: contributing.md
- - Code of Conduct: code_of_conduct.md
- - License: license.md
- - Release Notes:
+ - Changelog:
- Changelog: changelog.md
- Deprecated: deprecated.md
@@ -122,19 +111,19 @@ theme:
name: Switch to light mode
font:
- text: Roboto
- code: Roboto Mono
+ text: Inter
+ code: IBM Plex Mono
features:
- content.code.copy
- content.code.annotate
plugins:
- search
- - mkdocs-jupyter:
- kernel_name: python3
- execute: false
- include_source: True
- include_requirejs: true
+ # - mkdocs-jupyter:
+ # kernel_name: python3
+ # execute: false
+ # include_source: True
+ # include_requirejs: true
- mkdocstrings:
default_handler: python
handlers: