mkdocs.yml

# Documentation site configuration. The site is built into site/, which is
# gitignored and excluded from the UPM and npm package payloads.
site_name: Data Visualizer
site_description: Find, inspect, organize, and edit ScriptableObject data in one Unity editor window.
site_url: https://wallstop.github.io/DataVisualizer/
repo_url: https://github.com/wallstop/DataVisualizer
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site
strict: true

# admonition backs the `!!! note` callouts; tables and fenced code are already
# MkDocs defaults.
markdown_extensions:
  - admonition

# The README screenshots stay out of the site until the offscreen capture path
# paints every element (issue #114). The README links to them from
# raw.githubusercontent.com, so they stay in the repository. Unity's .meta
# companions are importer bookkeeping and must not be published either.
exclude_docs: |
  images/
  *.meta

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting started: getting-started.md

validation:
  nav:
    omitted_files: warn
    not_found: warn
  links:
    not_found: warn
    absolute_links: relative_to_docs
    unrecognized_links: warn