mkdocs.yml

site_name: SignalFlow
site_url: https://signalflow.dev/
site_description: "SignalFlow is a sound synthesis framework designed for exploring complex sonic ideas."
repo_name: ideoforms/signalflow
repo_url: https://github.com/ideoforms/signalflow

theme:
  name: material
  logo: images/sinewave.svg
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
   # enable button to copy code block
   - content.code.copy
   # expand all navigation sections on large screens
   - navigation.sections
   # breadcrumbs (not yet available, to arrive in a future version)
   - navigation.path
   # allow each section's title to be a hyperlinked index page
   - navigation.indexes
   # "back to top" button
   - navigation.top
   # footer with next/previous links
   - navigation.footer
   - navigation.tabs
  font:
    text: "IBM Plex Sans"
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ideoforms
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/ideoforms

markdown_extensions:
 - admonition
 - attr_list
 - pymdownx.tabbed
 - pymdownx.highlight
 - pymdownx.superfences
 - meta

plugins:
 - include-markdown
 - search
 - git-revision-date-localized:
     enable_creation_date: true
     type: timeago

nav:
 - Getting started:
   - Getting started: index.md
   - Installation:
     - Installation: installation/index.md
     - Easy installation: installation/easy.md
     - Command-line installation: installation/command-line.md
   - Examples: examples.md
   - License: license.md
 - Elements:
   - The AudioGraph:
     - The AudioGraph: graph/index.md
     - Creating the graph: graph/creating.md
     - Configuration: graph/config.md
     - Status and properties: graph/properties.md
     - Recording the audio output: graph/recording.md
     - Stopping the graph: graph/stopping.md
   - Nodes:
     - Nodes: node/index.md
     - Playback: node/playback.md
     - Inputs: node/inputs.md
     - Operators: node/operators.md
     - Multichannel: node/multichannel.md
     - Status and properties: node/properties.md
     - Stochastic nodes: node/stochastic.md
     - Developing a new Node class: node/developing.md
   - Patches:
     - Patches: patch/index.md
     - Defining a Patch: patch/defining.md
     - Playback: patch/playback.md
     - Inputs: patch/inputs.md
     - Operators: patch/operators.md
     - Properties: patch/properties.md
     - Exporting and importing: patch/exporting.md
     - Auto-free and memory management: patch/auto-free.md
   - Buffers:
     - Buffers: buffer/index.md
     - Creating and loading: buffer/creating.md
     - Saving and exporting: buffer/exporting.md
     - Passing to a node or patch: buffer/input.md
     - Accessing a buffer's contents: buffer/access.md
     - Operators: buffer/operators.md
     - Properties: buffer/properties.md
 - Troubleshooting:
   - Troubleshooting: troubleshooting/index.md
   - Installation problems: troubleshooting/installation.md
   - Exceptions:
     - InsufficientBufferSizeException: troubleshooting/insufficient_buffer_size_exception.md
     - DeviceNotFoundException: troubleshooting/device_not_found_exception.md
     - NodeNotPlayingException: troubleshooting/node_not_playing_exception.md
     - NodeAlreadyPlayingException: troubleshooting/node_already_playing_exception.md
 - Reference library:
   - "Reference library": library/index.md
   - "Analysis": library/analysis/index.md
   - "Buffer": library/buffer/index.md
   - "Control": library/control/index.md
   - "Envelope": library/envelope/index.md
   - "FFT": library/fft/index.md
   - "Operators": library/operators/index.md
   - "Oscillators": library/oscillators/index.md
   - "Processors": library/processors/index.md
   - "Processors: Delays": library/processors/delays/index.md
   - "Processors: Distortion": library/processors/distortion/index.md
   - "Processors: Dynamics": library/processors/dynamics/index.md
   - "Processors: Filters": library/processors/filters/index.md
   - "Processors: Panning": library/processors/panning/index.md
   - "Sequencing": library/sequencing/index.md
   - "Stochastic": library/stochastic/index.md

not_in_nav: |
  library/*/*.md
  library/*/*/*.md
  library/*/*/*/*.md
  installation/next-steps.md
  planning/*