MkDocs validation and Export internal linking (#10368)
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
parent
8558bec402
commit
632c906578
22 changed files with 289 additions and 279 deletions
52
mkdocs.yml
52
mkdocs.yml
|
|
@ -1,5 +1,10 @@
|
|||
# Ultralytics YOLO 🚀, AGPL-3.0 license
|
||||
|
||||
# Configuration file for building the Ultralytics YOLO documentation site using MkDocs.
|
||||
# Provides settings to control site metadata, customize the appearance using the
|
||||
# Material theme, define the navigation structure, and enable various plugins.
|
||||
|
||||
# Site metadata
|
||||
site_name: Ultralytics YOLOv8 Docs
|
||||
site_description: Explore Ultralytics YOLOv8, a cutting-edge real-time object detection and image segmentation model for various applications and hardware platforms.
|
||||
site_url: https://docs.ultralytics.com
|
||||
|
|
@ -11,6 +16,7 @@ remote_name: https://github.com/ultralytics/docs
|
|||
docs_dir: "docs/en/" # where to find the markdown files
|
||||
site_dir: "site/" # where to publish to
|
||||
|
||||
# Theme customization
|
||||
theme:
|
||||
name: material
|
||||
language: en
|
||||
|
|
@ -42,7 +48,6 @@ theme:
|
|||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
features:
|
||||
# - announce.dismiss
|
||||
- content.action.edit
|
||||
- content.code.annotate
|
||||
- content.code.copy
|
||||
|
|
@ -71,40 +76,6 @@ extra: # version:
|
|||
analytics:
|
||||
provider: google
|
||||
property: G-2M5EHKC0BH
|
||||
# alternate: # language drop-down
|
||||
# - name: 🇬🇧 English
|
||||
# link: /
|
||||
# lang: en
|
||||
# - name: 🇨🇳 简体中文
|
||||
# link: /zh/
|
||||
# lang: zh
|
||||
# - name: 🇰🇷 한국어
|
||||
# link: /ko/
|
||||
# lang: ko
|
||||
# - name: 🇯🇵 日本語
|
||||
# link: /ja/
|
||||
# lang: ja
|
||||
# - name: 🇷🇺 Русский
|
||||
# link: /ru/
|
||||
# lang: ru
|
||||
# - name: 🇩🇪 Deutsch
|
||||
# link: /de/
|
||||
# lang: de
|
||||
# - name: 🇫🇷 Français
|
||||
# link: /fr/
|
||||
# lang: fr
|
||||
# - name: 🇪🇸 Español
|
||||
# link: /es/
|
||||
# lang: es
|
||||
# - name: 🇵🇹 Português
|
||||
# link: /pt/
|
||||
# lang: pt
|
||||
# - name: 🇮🇳 हिन्दी
|
||||
# link: /hi/
|
||||
# lang: hi
|
||||
# - name: 🇸🇦 العربية
|
||||
# link: /ar/
|
||||
# lang: ar
|
||||
social:
|
||||
- icon: fontawesome/brands/github
|
||||
link: https://github.com/ultralytics
|
||||
|
|
@ -150,6 +121,17 @@ markdown_extensions:
|
|||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
|
||||
# Validation settings https://www.mkdocs.org/user-guide/configuration/#validation
|
||||
validation:
|
||||
nav:
|
||||
omitted_files: info
|
||||
not_found: warn
|
||||
absolute_links: info
|
||||
links:
|
||||
absolute_links: relative_to_docs
|
||||
anchors: warn
|
||||
unrecognized_links: warn
|
||||
|
||||
# Primary navigation ---------------------------------------------------------------------------------------------------
|
||||
nav:
|
||||
- Home:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue