mkdocs.yml

site_name: Plugin Essentials Documentation
site_url: https://tenebrisnoctua.github.io/PluginEssentials/
repo_name: TenebrisNoctua/PluginEssentials
repo_url: https://github.com/TenebrisNoctua/PluginEssentials

extra:
  version:
    provider: mike

theme:
  logo: img/light/pe_small.png
  logo_dark: img/dark/pe_small.png
  favicon: img/dark/pe_small.png
  custom_dir: docs/overrides
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.path
    - navigation.indexes 
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en

  palette:
    - scheme: pedoc-dark
      toggle:
        icon: octicons/sun-24
        name: Switch to Light Mode

    - scheme: pedoc-light 
      toggle:
        icon: octicons/moon-24
        name: Switch To Dark Mode
  icon:
    repo: octicons/mark-github-16

extra_css:
  - css/colors.css
  - css/theme.css
  - css/code.css
  - css/api-reference.css
  - css/paragraph.css
  - css/home.css

markdown_extensions:
  - toc
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - pymdownx.extra
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

nav:
  - Home: index.md
  - Tutorials:
    - Tutorials: tutorials/index.md
    - Plugin Components:
      - tutorials/plugin-components/widgetCreation.md
      - tutorials/plugin-components/toolbarCreation.md
    - Studio Components:
      - tutorials/studio-components/basicComponents.md
      - tutorials/studio-components/buttons.md
      - tutorials/studio-components/inputs.md
      - tutorials/studio-components/advancedComponents.md
  - API Reference:
      - API Reference: api-reference/index.md
      - General:
          setFusion: api-reference/setFusion.md
      - Plugin Components:
        - Members:
          - Widget: api-reference/plugin-components/members/Widget.md
          - Toolbar: api-reference/plugin-components/members/Toolbar.md
          - ToolbarButton: api-reference/plugin-components/members/ToolbarButton.md
        - Types:
          - WidgetProperties: api-reference/plugin-components/types/Widget.md
          - ToolbarProperties: api-reference/plugin-components/types/Toolbar.md
          - ToolbarButtonProperties: api-reference/plugin-components/types/ToolbarButton.md
      - Studio Components:
        - Members:
          - Scroll Frames:
            - BaseScrollFrame: api-reference/studio-components/members/scrollframe/BaseScrollFrame.md
            - ScrollFrame: api-reference/studio-components/members/scrollframe/ScrollFrame.md
          - Buttons:
            - BaseButton: api-reference/studio-components/members/buttons/BaseButton.md
            - Button: api-reference/studio-components/members/buttons/Button.md
            - IconButton: api-reference/studio-components/members/buttons/IconButton.md
            - MainButton: api-reference/studio-components/members/buttons/MainButton.md
          - Inputs:
            - TextInput: api-reference/studio-components/members/input/TextInput.md
            - LimitedTextInput: api-reference/studio-components/members/input/LimitedTextInput.md
          - Dropdown Menu:
            - Dropdown: api-reference/studio-components/members/dropdown/Dropdown.md
            - DropdownItem: api-reference/studio-components/members/dropdown/DropdownItem.md
          - Util:
            - getDragInput: api-reference/studio-components/members/util/getDragInput.md
            - getModifier: api-reference/studio-components/members/util/getModifier.md
            - getMotionState: api-reference/studio-components/members/util/getMotionState.md
            - getSelectedState: api-reference/studio-components/members/util/getSelectedState.md
            - getState: api-reference/studio-components/members/util/getState.md
            - themeProvider: api-reference/studio-components/members/util/themeProvider.md
          - Background: api-reference/studio-components/members/Background.md
          - Shadow: api-reference/studio-components/members/Shadow.md
          - BoxBorder: api-reference/studio-components/members/BoxBorder.md
          - ClassIcon: api-reference/studio-components/members/ClassIcon.md
          - Label: api-reference/studio-components/members/Label.md
          - Title: api-reference/studio-components/members/Title.md
          - Loading: api-reference/studio-components/members/Loading.md
          - Checkbox: api-reference/studio-components/members/Checkbox.md
          - ColorPicker: api-reference/studio-components/members/ColorPicker.md
          - ProgressBar: api-reference/studio-components/members/ProgressBar.md
          - Slider: api-reference/studio-components/members/Slider.md
          - VerticalCollapsibleSection: api-reference/studio-components/members/VerticalCollapsibleSection.md
          - VerticalExpandingList: api-reference/studio-components/members/VerticalExpandingList.md
        - Types:
          - Scroll Frames:
            - BaseScrollFrameProperties: api-reference/studio-components/types/scrollframe/BaseScrollFrame.md
            - ScrollFrameProperties: api-reference/studio-components/types/scrollframe/ScrollFrame.md
          - Buttons:
            - BaseButtonProperties: api-reference/studio-components/types/buttons/BaseButton.md
            - IconButtonProperties: api-reference/studio-components/types/buttons/IconButton.md
          - Inputs:
            - TextInputProperties: api-reference/studio-components/types/input/TextInput.md
            - LimitedTextInputProperties: api-reference/studio-components/types/input/LimitedTextInput.md
          - Dropdown Menu:
            - DropdownProperties: api-reference/studio-components/types/dropdown/Dropdown.md
            - DropdownItemProperties: api-reference/studio-components/types/dropdown/DropdownItem.md
          - Util:
            - DragInputProperties: api-reference/studio-components/types/util/getDragInput.md
            - ModifierInput: api-reference/studio-components/types/util/getModifier.md
            - GetSelectedStateProperties: api-reference/studio-components/types/util/getSelectedState.md
            - ThemeProvider: api-reference/studio-components/types/util/themeProvider.md
          - BackgroundProperties: api-reference/studio-components/types/Background.md
          - ShadowProperties: api-reference/studio-components/types/Shadow.md
          - BoxBorderProperties: api-reference/studio-components/types/BoxBorder.md
          - ClassIconProperties: api-reference/studio-components/types/ClassIcon.md
          - LabelProperties: api-reference/studio-components/types/Label.md
          - LoadingProperties: api-reference/studio-components/types/Loading.md
          - CheckboxProperties: api-reference/studio-components/types/Checkbox.md
          - ColorPickerProperties: api-reference/studio-components/types/ColorPicker.md
          - ProgressBarProperties: api-reference/studio-components/types/ProgressBar.md
          - SliderProperties: api-reference/studio-components/types/Slider.md
          - VerticalCollapsibleSectionProperties: api-reference/studio-components/types/VerticalCollapsibleSection.md
          - VerticalExpandingListProperties: api-reference/studio-components/types/VerticalExpandingList.md
      
copyright: |
  &copy; 2025 <a href="https://github.com/TenebrisNoctua"  target="_blank" rel="noopener">Tenebris Noctua</a>