benefits/mkdocs.yml at main · cal-itp/benefits · 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
site_name: "cal-itp/benefits: documentation"
repo_url: https://github.com/cal-itp/benefits
edit_uri: edit/dev/docs
site_url: https://docs.calitp.org/benefits
exclude_docs: |
  **/inc/*.md

theme:
  name: material
  features:
    - content.code.copy
    - navigation.expand
    - navigation.tabs
    - toc.integrate
  palette:
    scheme: default

extra:
  analytics:
    provider: google
    property: G-SZB618VNBZ

plugins:
  - search
  - awesome-pages
  - redirects:
      redirect_maps:
        "configuration/admin-interface.md": "reference/environment-variables.md#django-admin-interface"
        "configuration/data.md": "tutorials/load-sample-data.md"
        "configuration/content-security-policy.md": "reference/environment-variables.md#django-csp"
        "configuration/environment-variables.md": "reference/environment-variables.md"
        "configuration/rate-limit.md": "reference/rate-limit.md"
        "configuration/README.md": "explanation/configuration.md"
        "configuration/recaptcha.md": "reference/environment-variables.md#recaptcha"
        "configuration/transit-provider.md": "guides/onboard-transit-provider.md"

        "deployment/azure.md": "explanation/infrastructure.md"
        "deployment/infrastructure.md": "explanation/infrastructure.md"
        "deployment/hotfix.md": "guides/hotfix.md"
        "deployment/README.md": "explanation/deployment.md"
        "deployment/release.md": "guides/release.md"
        "deployment/rollback.md": "guides/rollback.md"
        "deployment/secrets.md": "tutorials/secrets.md"
        "deployment/troubleshooting.md": "guides/troubleshooting.md"
        "deployment/workflows.md": "explanation/deployment.md"

        "development/application-logic.md": "explanation/development/application-logic.md"
        "development/commits-branches-merging.md": "explanation/development/commits-branches-merging.md"
        "development/docker-dynamic-ports.md": "explanation/development/docker-dynamic-ports.md"
        "development/i18n.md": "explanation/development/i18n.md"
        "development/linting-pre-commit.md": "explanation/development/linting-pre-commit.md"
        "development/models-migrations.md": "explanation/development/models-migrations.md"
        "development/README.md": "explanation/development/README.md"
        "development/test-server.md": "explanation/development/test-server.md"

        "enrollment-pathways/agency-cards.md": "explanation/enrollment-pathways/agency-cards.md"
        "enrollment-pathways/low-income.md": "explanation/enrollment-pathways/low-income.md"
        "enrollment-pathways/medicare-cardholders.md": "explanation/enrollment-pathways/medicare-cardholders.md"
        "enrollment-pathways/older-adults.md": "explanation/enrollment-pathways/older-adults.md"
        "enrollment-pathways/README.md": "index.md#supported-enrollment-pathways"
        "enrollment-pathways/veterans.md": "explanation/enrollment-pathways/veterans.md"

        "getting-started/development.md": "explanation/development/README.md"
        "getting-started/documentation.md": "guides/documentation.md"
        "getting-started/docker-dynamic-ports.md": "explanation/development/docker-dynamic-ports.md"
        "getting-started/README.md": "guides/getting-started.md"

        "guides/manual-tests.md": "guides/manual-testing/getting-started.md"

        "product-and-design/analytics.md": "reference/analytics.md"
        "product-and-design/copy-delivery.md": "guides/copy-delivery.md"
        "product-and-design/copy-style.md": "reference/copy-style.md"
        "product-and-design/newsletter-archive.md": "reference/newsletter-archive/index.md"
        "product-and-design/use-cases/enrollment-use-cases.md": "index.md#supported-enrollment-pathways"

        "reference/admin-interface.md": "reference/environment-variables.md#django-admin-interface"
        "reference/content-security-policy.md": "reference/environment-variables.md#django-csp"
        "reference/recaptcha.md": "reference/environment-variables.md#recaptcha"

        "tests/automated-tests.md": "guides/automated-tests.md"
        "tests/manual-tests.md": "guides/manual-tests.md"

        "use-cases/courtesy-cards.md": "explanation/enrollment-pathways/agency-cards.md"

extra_css:
  - styles/theme.css
  - https://use.fontawesome.com/releases/v5.13.0/css/all.css

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - codehilite:
      linenums: true
  - mdx_truly_sane_lists
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: !relative # Relative to the current Markdown file


  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.smartsymbols
  - meta
  - toc:
      # insert a blank space before the character
      permalink: " ¶"
  - smarty