-
Notifications
You must be signed in to change notification settings - Fork 71
/
mkdocs.yml
198 lines (189 loc) · 6.09 KB
/
mkdocs.yml
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# Project information
site_name: Accessibility Theme Builder
site_url: https://finos.github.io/a11y-theme-builder/
site_author: Discover Technology Academy
site_description: >-
A system for generating machine readable asset types allowing design
systems to publish products that are accessibly inclusive.
# Repository information
repo_name: finos/a11y-theme-builder
repo_url: https://github.com/finos/a11y-theme-builder
# Content Generator Settings
docs_dir: 'docs'
site_dir: 'html'
# Copyright information
copyright: >-
Copyright © 2023 Discover Financial Services.</br>
By accessing this website or content, you agree to these
<a href="https://www.discover.com/credit-cards/discover-terms-of-use/?ICMPGN=PUB_FTR_QL_TERMS">Terms of Use</a>.
</br>
extra_css:
- stylesheets/extra.css
# Theme Configuration
theme:
name: material
custom_dir: overrides
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
# - navigation.instant
# - navigation.prune
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
palette:
- scheme: default
primary: white
accent: green
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: grey
accent: yellow
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
favicon: theme/images/favicon.png
logo: theme/images/logo.png
icon:
logo: logo
launch: material/launch
# Plugins
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
# Customization
extra:
annotate:
json: [.s2]
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
social:
- icon: fontawesome/brands/github
link: https://github.com/squidfunk
- icon: fontawesome/brands/gitter
link: https://gitter.im/squidfunk/mkdocs-material
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/squidfunk/mkdocs-material/
- icon: fontawesome/brands/python
link: https://pypi.org/project/mkdocs-material/
- icon: fontawesome/brands/mastodon
link: https://fosstodon.org/@squidfunk
- icon: fontawesome/brands/twitter
link: https://twitter.com/squidfunk
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Page Navigation Structure
nav:
- Overview:
- index.md
- Situation: motivation/situation.md
- Workflow Challenges: motivation/challenges.md
- Imagine: motivation/imagine.md
- Solution: motivation/solution.md
- Getting started:
- setup/index.md
- Prerequisites: setup/dependencies.md
- Installation: setup/app-installation.md
- Running Theme Builder: setup/start-builder.md
- Contribute:
- contribute/index.md
- Reporting a bug: https://github.com/finos/a11y-theme-builder/issues
- Reporting a docs issue: https://github.com/finos/a11y-theme-builder/issues
- Requesting a change: https://github.com/finos/a11y-theme-builder/issues
- Asking a question: https://github.com/finos/a11y-theme-builder/discussions
- Designers:
- designers/index.md
- What is a design system: designers/what-is-a-design-system.md
- How to configure fonts: designers/how-to-configure-fonts.md
- How to configure disability overlays: designers/how-to-configure-overlays.md
- How to work with Design Tokens: designers/how-to-work-with-tokens.md
- How to use components with Storybook: designers/how-to-work-with-storybook.md
- Under the Hood:
- architecture/index.md
- Component Model: architecture/component-model.md
- Why Mui: decisions/mui_adr.md
- Understanding SDK: architecture/sdk-intro.md
- Foundational Services: architecture/base-services.md
- Understanding Application APIs: architecture/app-api.md
- Extending the Tool:
- developers/index.md
- Code Walkthrough: developers/code-walkthrough.md
- Adding Atomic Elements: developers/add-atomic-elements.md
- Adding Accessibility Layers: developers/add-a11y-layers.md
- Adding output generators: developers/add-output-generators.md
- Adding storage: developers/add-storage.md
- Managing light and dark modes: developers/managing-modes.md
- Guides:
- guides/index.md
- Create a design system: guides/create-a-design-system.md
- Replace Sample Preview: guides/replace-sample-app.md
- Testing a Theme with Fable: guides/test-theme-with-fable.md
- Create React Components: guides/create-react-component.md
- Design workflow with Figma Tokens: guides/design-workflow-with-tokens.md
- Using alternative Javascript libraries: guides/alternative-js-libs.md
- Using SDK headless in CI/CD pipeline: guides/headless-sdk-for-cicd-pipeline.md
- Glossary:
- glossary/index.md
- References:
- references/index.md