forked from bumble-tech/appyx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
192 lines (182 loc) · 7.59 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
# General setup
site_name: Appyx
site_url: https://bumble-tech.github.io/appyx/
site_author: Bumble
site_description: Model-driven navigation + UI components with gesture control for Compose Multiplatform
# Repository
repo_name: Appyx
repo_url: https://github.com/bumble-tech/appyx
edit_uri: ""
# Copyright
copyright: Copyright © 2022 - 2023 Bumble
# Navigation
docs_dir: documentation
nav:
- Home: index.md
- Appyx Navigation:
- Overview: navigation/index.md
- Quick start guide: navigation/quick-start.md
- Concepts:
- Model-driven navigation: navigation/concepts/model-driven-navigation.md
- Composable navigation: navigation/concepts/composable-navigation.md
- Implicit navigation: navigation/concepts/implicit-navigation.md
- Explicit navigation: navigation/concepts/explicit-navigation.md
- Features:
- Deep linking: navigation/features/deep-linking.md
- Scoped DI: navigation/features/scoped-di.md
- Lifecycle: navigation/features/lifecycle.md
- Plugins: navigation/features/plugins.md
- ChildAware API: navigation/features/childaware.md
- Surviving configuration changes: navigation/features/surviving-configuration-changes.md
- Integrations:
- Compose Navigation: navigation/integrations/compose-navigation.md
- DI frameworks: navigation/integrations/di-frameworks.md
- RIBs: navigation/integrations/ribs.md
- RxJava: navigation/integrations/rx.md
- ViewModel: navigation/integrations/viewmodel.md
- Multiplatform: navigation/multiplatform.md
- Appyx Interactions:
- Overview: interactions/index.md
- Using components: interactions/usage.md
- Creating your own:
- Component overview: interactions/appyxcomponent.md
- Transition model: interactions/transitionmodel.md
- Operations: interactions/operations.md
- UI representation: interactions/ui-representation.md
- KSP setup: interactions/ksp.md
- Gestures: interactions/gestures.md
- Appyx Components:
- Overview: components/index.md
- Back stack: components/backstack.md
- Spotlight: components/spotlight.md
- Experimental: components/experimental.md
- Releases:
- Downloads: releases/downloads.md
- Changelog: releases/changelog.md
- 2.x:
- Migration guide: 2.x/migrationguide.md
- 1.x:
- Overview: 1.x/index.md
- Releases:
- Downloads: 1.x/releases/downloads.md
- Changelog: 1.x/releases/changelog.md
- Using Appyx:
- Quick start guide: 1.x/how-to-use-appyx/quick-start.md
- Codelabs: 1.x/how-to-use-appyx/codelabs.md
- Coding challenges: 1.x/how-to-use-appyx/coding-challenges.md
- Sample apps: 1.x/how-to-use-appyx/sample-apps.md
- Navigation:
- Model-driven navigation: 1.x/navigation/model-driven-navigation.md
- NavModel:
- Overview: 1.x/navmodel/index.md
- Back stack: 1.x/navmodel/backstack.md
- Spotlight: 1.x/navmodel/spotlight.md
- Cards: 1.x/navmodel/cards.md
- Tiles: 1.x/navmodel/tiles.md
- Promoter: 1.x/navmodel/promoter.md
- Writing your own: 1.x/navmodel/custom.md
- Composable navigation: 1.x/navigation/composable-navigation.md
- Implicit navigation: 1.x/navigation/implicit-navigation.md
- Explicit navigation: 1.x/navigation/explicit-navigation.md
- Deep linking: 1.x/navigation/deep-linking.md
- UI:
- Children: 1.x/ui/children-view.md
- Transitions: 1.x/ui/transitions.md
- App:
- Structuring your app navigation: 1.x/apps/structure.md
- Lifecycle: 1.x/apps/lifecycle.md
- Plugins: 1.x/apps/plugins.md
- ChildAware API: 1.x/apps/childaware.md
- Configuration changes: 1.x/apps/configuration.md
- FAQ: 1.x/faq.md
- FAQ: faq.md
# theme configuration
theme:
name: 'material'
logo: assets/logo.png
icon:
repo: fontawesome/brands/github
language: en
include_search_page: false
search_index_only: true
features:
# - navigation.tabs
- search.highlight
- search.share
- search.suggest
palette:
scheme: default
primary: amber
accent: amber
font:
text: Roboto
code: Roboto Mono
favicon: assets/favicon.svg
extra_css:
- stylesheets/extra.css
plugins:
- search
- include-markdown
- macros:
module_name: compose_mpp_sample
on_error_fail: true
- social:
cards_layout_options:
background_color: white
- redirects:
redirect_maps:
'how-to-use-appyx/quick-start.md': '1.x/how-to-use-appyx/quick-start.md'
'how-to-use-appyx/codelabs.md': '1.x/how-to-use-appyx/codelabs.md'
'how-to-use-appyx/coding-challenges.md': '1.x/how-to-use-appyx/coding-challenges.md'
'how-to-use-appyx/sample-apps.md': '1.x/how-to-use-appyx/sample-apps.md'
'navigation/model-driven-navigation.md': 'navigation/concepts/model-driven-navigation.md'
'navmodel/index.md': 'components/index.md'
'navmodel/backstack.md': 'components/backstack.md'
'navmodel/spotlight.md': 'components/spotlight.md'
'navmodel/cards.md': 'components/experimental.md'
'navmodel/tiles.md': '1.x/navmodel/tiles.md'
'navmodel/promoter.md': '1.x/navmodel/promoter.md'
'navmodel/custom.md': 'interactions/appyxcomponent.md'
'navigation/composable-navigation.md': 'navigation/concepts/composable-navigation.md'
'navigation/implicit-navigation.md': 'navigation/concepts/implicit-navigation.md'
'navigation/explicit-navigation.md': 'navigation/concepts/explicit-navigation.md'
'navigation/deep-linking.md': 'navigation/features/deep-linking.md'
'ui/children-view.md': '1.x/ui/children-view.md'
'ui/transitions.md': '1.x/ui/transitions.md'
'apps/structure.md': 'navigation/concepts/composable-navigation.md'
'apps/lifecycle.md': 'navigation/features/lifecycle.md'
'apps/plugins.md': 'navigation/features/plugins.md'
'apps/childaware.md': 'navigation/features/childaware.md'
'apps/configuration.md': 'navigation/features/surviving-configuration-changes.md'
'news.md': 'index.md'
'interactions/uirepresentation.md': 'interactions/ui-representation.md'
'navigation/navigation/composable-navigation.md': 'navigation/concepts/composable-navigation.md'
'navigation/navigation/implicit-navigation.md': 'navigation/concepts/implicit-navigation.md'
'navigation/navigation/explicit-navigation.md': 'navigation/concepts/explicit-navigation.md'
'navigation/navigation/deep-linking.md': 'navigation/features/deep-linking.md'
'navigation/apps/structure.md': 'navigation/concepts/composable-navigation.md'
'navigation/apps/lifecycle.md': 'navigation/features/lifecycle.md'
'navigation/apps/plugins.md': 'navigation/features/plugins.md'
'navigation/apps/childaware.md': 'navigation/features/childaware.md'
'navigation/apps/configuration.md': 'navigation/features/surviving-configuration-changes.md'
'navigation/features/configuration.md': 'navigation/features/surviving-configuration-changes.md'
# extensions
markdown_extensions:
- admonition
- pymdownx.critic
- codehilite
- footnotes
- meta
- toc:
permalink: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format