Accessible-Math-Reader/mkdocs.yml at master · AndyFerns/Accessible-Math-Reader · 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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# ============================================================================
# Accessible Math Reader — MkDocs Configuration
# ============================================================================
# Documentation:  https://www.mkdocs.org/
# Material theme: https://squidfunk.github.io/mkdocs-material/
#
# Quick start:
#   pip install mkdocs mkdocs-material mkdocstrings[python]
#   mkdocs serve          # live preview at http://127.0.0.1:8000
#   mkdocs build          # generate static site in site/
#   mkdocs gh-deploy      # deploy to GitHub Pages
# ============================================================================

site_name: Accessible Math Reader
site_description: Screen-reader-first math accessibility toolkit for LaTeX/MathML to speech and Braille
site_url: https://andyferns.github.io/Accessible-Math-Reader/
repo_url: https://github.com/AndyFerns/Accessible-Math-Reader
repo_name: AndyFerns/Accessible-Math-Reader
edit_uri: edit/main/docs/

# ---------------------------------------------------------------------------
# Theme
# ---------------------------------------------------------------------------
theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

# ---------------------------------------------------------------------------
# Navigation
# ---------------------------------------------------------------------------
nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Input Formats: input-formats.md
      - Configuration: configuration.md
      - Accessibility: accessibility.md
      - Examples: examples.md
  - API Reference: api.md
  - Architecture: architecture.md
  - Deployment: deployment.md
  - Contributing: contributing.md

# ---------------------------------------------------------------------------
# Plugins
# ---------------------------------------------------------------------------
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 3

# ---------------------------------------------------------------------------
# Markdown Extensions
# ---------------------------------------------------------------------------
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

# ---------------------------------------------------------------------------
# Extra
# ---------------------------------------------------------------------------
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AndyFerns/Accessible-Math-Reader