mkdocs.yml

site_name: ProjectM TV and Android
site_description: MilkDrop visuals for Android TV, phones and tablets, the ProjectM TV Engine, and a source-level guide to writing presets.
site_url: https://johnneerdael.github.io/ProjectM-Android/
repo_url: https://github.com/johnneerdael/ProjectM-Android
repo_name: johnneerdael/ProjectM-Android
edit_uri: blob/main/docs/user-guide/
docs_dir: docs/user-guide
site_dir: build/user-guide-site
theme:
  name: material
  language: en
  palette:
    scheme: slate
    primary: custom
    accent: custom
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    logo: material/waveform
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
extra_css:
  - stylesheets/projectm.css
plugins:
  - search
markdown_extensions:
  - tables
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
nav:
  - Home: index.md
  - Use it:
      - Install and get started: getting-started.md
      - Touchscreen and remote controls: controls.md
      - Settings reference: settings.md
      - Preset moods: predictive-collections.md
      - Custom preset packs: custom-packs.md
      - Picture quality and performance: picture-quality.md
      - Troubleshooting: troubleshooting.md
  - Write presets:
      - authoring/index.md
      - Anatomy of a .milk file: authoring/milk-format.md
      - The frame, step by step: authoring/execution.md
      - Equations: authoring/equations.md
      - Shaders: authoring/shaders.md
      - Textures: authoring/textures.md
      - Motion, waves, shapes and blur: authoring/effects.md
      - Test and predict presets: authoring/testing.md
      - Checklist: authoring/checklist.md
  - Engine:
      - engine/index.md
      - Patch catalog: engine/patches.md
      - Rendering MilkDrop at 4K: engine/resolution.md
      - How a frame reaches your screen: engine/pipeline.md
      - Validation and evidence: engine/validation.md
  - Predictor:
      - How ProjectM TV understands presets: predictor.md
      - Reading a preset: predictor/source-reading.md
      - Feedback, brightness and motion: predictor/feedback-maths.md
      - Colour and palettes: predictor/colour.md
      - From estimates to moods: predictor/mood-table.md
      - Accuracy: predictor/accuracy.md
      - Prediction images: predictor/prediction-images.md
      - Predictions vs real renders: predictor/gallery.md
      - The JSON output: predictor/json-output.md
      - The SDK: predictor/sdk.md
      - Research journal: predictor/journal.md
      - The road ahead: predictor/future.md
      - Export contracts: predictor-export.md
  - Build and test: development.md
not_in_nav: |
  /dance.md
  /dance-measurement.md
validation:
  links:
    not_found: warn
    anchors: warn