mkdocs.yml

site_name: Mutagen Documentation
site_url: https://mutagen-modding.github.io/Mutagen/

repo_name: Mutagen
repo_url: https://github.com/Mutagen-Modding/Mutagen

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Mutagen-Modding
    - icon: fontawesome/brands/discord
      link: https://discord.gg/GdKZ3SH

markdown_extensions:
  - admonition
  - tables
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences 
  - pymdownx.tasklist
  - def_list
  - meta
  - md_in_html
  - attr_list
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - glightbox:
      zoomable: true
      draggable: true

theme:
  name: material
  font:
    text: Inter
  palette:
    primary: custom 
    accent: custom
    scheme: slate
  favicon: mutagen-icon.png
  logo: mutagen-icon.png
  features:
    - content.tooltips
    - content.code.copy
    - navigation.instant
    - navigation.tracking
    - navigation.indexes 
    - navigation.path
    
nav:
  - Home: index.md
  - Big Cheat Sheet: Big-Cheat-Sheet.md
  - Plugin Record Suite:
    - plugins/index.md
    - ModKey, FormKey, FormLink: plugins/ModKey, FormKey, FormLink.md
    - Importing and Construction: plugins/Importing-and-Construction.md
    - Exporting: plugins/Exporting.md
    - Interfaces (Aspect/Link/Getters): plugins/Interfaces.md
    - Copy Functionality: plugins/Copy-Functionality.md
    - Equality Checks: plugins/Equality-Checks.md
    - Translation Masks: plugins/Translation-Masks.md
    - Flags and Enums: plugins/Flags-and-Enums.md
    - Asset Links: plugins/AssetLink.md
    - Compaction: plugins/Compaction.md
    - Create, Duplicate, and Override: plugins/Create,-Duplicate,-and-Override.md
    - Printing: plugins/Printing.md
    - Abstract Subclassing: plugins/Abstract-Subclassing.md
    - Specific Records:
      - plugins/specific/index.md
      - Globals and GameSettings: plugins/specific/Globals-And-GameSettings.md
    # - Perks:
    # - Magic Effects:
    # - Conditions:
    # - Npcs:
    - Bethesda Format Abstraction: plugins/Bethesda-Format-Abstraction.md
    - FormKey Allocation and Persistence: plugins/FormKey-Allocation-and-Persistence.md
    - Other Utility: plugins/other-utility.md
  - Environment:
    - environment/index.md
    - Environment Construction: environment/Environment-Construction.md
    - Game Locations: environment/Game-Locations.md
  - Link Cache:
    - linkcache/index.md
    - Record Resolves: linkcache/Record-Resolves.md
    - Scoping Type: linkcache/Scoping-Type.md
    - Mod Contexts: linkcache/ModContexts.md
    - Previous Override Iteration: linkcache/Previous-Override-Iteration.md
  - Load Order:
    - loadorder/index.md
    - Winning Override Iteration: loadorder/Winning-Overrides.md
    # - Has Mod Assertions
    # - Live File Monitoring
  - Archives (BSAs): Archives.md
  - Strings: Strings.md
  - Getting Familiar with C#:
    - Namespaces: familiar/Namespaces.md
    # - Intellisense
    - Nullability to Indicate Record Presence: familiar/Nullability-to-Indicate-Record-Presence.md
    # - Inspect Class Definitions
    # - Debugging
  - Best Practices:
    - Prefer Readonly Types: best-practices/Read-Only.md
    - Accessing Known Records: best-practices/Accessing-Known-Records.md
    - FormLinks Target Getter Interfaces: best-practices/FormLinks-Target-Getter-Interfaces.md
    - FormLinks vs EditorID as Identifiers: best-practices/FormLinks-vs-EditorID-as-Identifiers.md
    - FormLink Nullability: best-practices/FormLink-Nullability.md
    # - FormLinks vs FormID/FormKey as Identifiers:
    # - Reference FormLinks By EditorID:
    # - LinkCache Resolution Type Choice:
    # - Lists vs HashSet:
    - Enumerable Laziness: best-practices/Enumerable-Laziness.md
    - TryGet Concepts: best-practices/TryGet-Concepts.md
    - Access Overlays Once: best-practices/Overlays-Single-Access.md
    - ITPO Avoidance: best-practices/ITPO-Avoidance.md
    - Reuse Translation Masks: best-practices/Reuse-Translation-Masks.md
    - Modifying Groups Being Iterated: best-practices/Modifying-Groups-Being-Iterated.md
    - Enriching Exceptions: best-practices/Enrich-Exceptions.md
    # - Testing:
    # - Auto Fixture:
    # - Major Record Test Building:
  - WPF Library:
    - wpf/index.md
    - FormKey Picker: wpf/FormKey-Picker.md
    - ModKey Picker: wpf/ModKey-Picker.md
    # - Load Order Display
    - Reflection Powered Settings: wpf/Reflection-Powered-Settings.md
    - Adding Required Resources: wpf/Adding-Required-Resources.md
  # - Dependency Injection: Dependency Injection
  - Json: Json.md
  - Low Level Tools:
    - lowlevel/index.md
    - C# Span: lowlevel/C#-Span.md
    - Header Structs: lowlevel/Header-Structs.md
    - Game Constants: lowlevel/Game-Constants.md
    - Binary Streams: lowlevel/Binary-Streams.md
    - Binary Utility: lowlevel/Binary-Utility.md
  - Game Specific Documentation:
    - Oblivion:
      - Oblivion Aspect Interfaces: game-specific/oblivion/Oblivion-Aspect-Interfaces.md
      - Oblivion Link Interfaces: game-specific/oblivion/Oblivion-Link-Interfaces.md
    - Skyrim:
      - Skyrim Perks: game-specific/skyrim/Skyrim-Perks.md
      - Skyrim Aspect Interfaces: game-specific/skyrim/Skyrim-Aspect-Interfaces.md
      - Skyrim Link Interfaces: game-specific/skyrim/Skyrim-Link-Interfaces.md
  - Correctness: Correctness.md
  - Contributing: Contributing.md