electionguard/mkdocs.yml at main · Fully-Homomorphic-Encryption/electionguard · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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
          - Features: overview/Features.md
          - Glossary: overview/Glossary.md
      - Basics:
          - Configure Election: basics/0_Configure_Election.md
          - Key Ceremony: basics/1_Key_Ceremony.md
          - Encrypt Ballots: basics/2_Encrypt_Ballots.md
          - Cast and Challenge Ballots: basics/3_Cast_and_Challenge_Ballots.md
          - Decrypt Tally: basics/4_Decrypt_Tally.md
          - Publish Results: basics/5_Publish_Results.md
          - Verify Election: basics/6_Verify_Election.md
      - Concepts:
          - Ballot Encryption: concepts/Ballot_Encryption.md
          - Election Manifest: concepts/Election_Manifest.md
          - Election Verification: concepts/Election_Verification.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
          - Repositories: develop/Repositories.md
          - Data Format: develop/Data_Format.md
  - Specification:
      - Current: spec/0.95.0/1_Overview.md
      - Badges: spec/Badges.md
      - Other Versions:
          - v0.85.0: spec/0.85.0/1_Overview.md
          - v0.95.0: spec/0.95.0/1_Overview.md
          - v1.0.0: spec/1.0.0/1_Overview.md

  - Contribute: contribute/index.md
plugins:
  - search
  - mermaid2
  - 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.expand
    - navigation.instant
    - navigation.tabs
markdown_extensions:
  - 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:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true
extra_javascript:
  - 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