mkdocs.yml

site_name: ElectionGuard
# site_description:
# site_author:
# google_analytics:
# remote_branch: for gh-deploy to GithubPages
# remote_name: for gh-deploy to Github Pages
# copyright:
docs_dir: "docs"
repo_url: https://github.com/microsoft/electionguard/
nav:
  - Documentation:
      - Overview:
          - What is ElectionGuard?: index.md
          - Roadmap: overview/Roadmap.md
          - Glossary: overview/Glossary.md
      - Elections:
          - College Park, Maryland 2023: elections/College_Park_Maryland_2023.md
          - Preston, Idaho 2022: elections/Preston_Idaho_2022.md
          - Fulton, Wisconsin 2020: elections/Fulton_Wisconsin_2020.md    
      - Events:
          - August 2022 ElectionGuard Hart Verity Scanner and Accessibility Convening: events/eg_usability_aug_2022.md
      - Reports:
          - End-to-End Verifiability in Real-World Elections: Reports/E2EVerifiability.md
      - Concepts:
          - Creating an Election Manifest:  concepts/Manifest_Building.md
          - Creating a Verifiable Election: concepts/Verifiability.md
          - Structures and Processes: concepts/Structure_and_Processes.md
      - Use Cases:
          - Precinct Scan: use_cases/Precinct_Scan.md
          - Rescans and Recounts: use_cases/Rescans_and_Recounts.md
      - Develop:
          - Getting Started: develop/Getting_Started.md
          - Versioning: develop/Versioning.md
          - Badges: develop/Badges.md
          - Repositories: develop/Repositories.md
          - Applications: develop/Applications.md
          - Data:
              - Data Schema: develop/Data_Schema.md
              - Election Record: develop/Election_Record.md
              - Sample Data: develop/Sample_Data.md
  - Specification:
      - Official: spec/index.md
      - Serialization: spec/Serialization_Spec.md
  - Contribute: contribute/index.md
plugins:
  - search
  - mermaid2:
      arguments:
        securityLevel: "loose"
        htmlLabels: true
  - redirects:
      redirect_maps:
        "hacktoberfest.md": "contribute/index.md"
theme:
  name: material
  custom_dir: overrides
  favicon: images/favicon.ico
  logo: images/electionguard-logo.png
  font:
    text: Segoe UI
  palette:
    scheme: default
    accent: indigo
    link: indigo
  features:
    - navigation.instant
    - navigation.tabs
markdown_extensions:
  - abbr
  - pymdownx.snippets
  - admonition
  - footnotes
  - meta
  - pymdownx.details
  - pymdownx.tabbed
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true
extra_javascript:
  - javascripts/analytics.js
  - javascripts/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra_css:
  - stylesheets/extra.css