xref: /aosp_15_r20/external/accompanist/mkdocs.yml (revision fa44fe6ae8e729aa3cfe5c03eedbbf98fb44e2c6)
1# Project information
2site_name: 'Accompanist'
3site_description: 'A group of libraries to help write Jetpack Compose apps.'
4site_author: 'Google'
5site_url: 'https://google.github.io/accompanist/'
6edit_uri: 'tree/main/docs/'
7remote_branch: gh-pages
8
9docs_dir: docs-gen
10
11# Repository
12repo_name: 'Accompanist'
13repo_url: 'https://github.com/google/accompanist'
14
15# Navigation
16nav:
17  - 'Overview': index.md
18  - 'Insets':
19    - 'Guide': insets.md
20    - 'API': api/insets/
21  - 'System UI Controller':
22    - 'Guide': systemuicontroller.md
23    - 'API': api/systemuicontroller/
24  - 'AppCompat Theme':
25    - 'Guide': appcompat-theme.md
26    - 'API': api/appcompat-theme/
27  - 'AppCompat Theme Adapter':
28    - 'Guide': themeadapter-appcompat.md
29    - 'API': api/themeadapter-appcompat/
30  - 'Material Theme Adapter':
31    - 'Guide': themeadapter-material.md
32    - 'API': api/themeadapter-material/
33  - 'Material 3 Theme Adapter':
34    - 'Guide': themeadapter-material3.md
35    - 'API': api/themeadapter-material3/
36  - 'Core Theme Adapter':
37    - 'Guide': themeadapter-core.md
38    - 'API': api/themeadapter-core/
39  - 'Pager layouts':
40    - 'Guide': pager.md
41    - 'API': api/pager/
42  - 'Swipe Refresh':
43    - 'Guide': swiperefresh.md
44    - 'API': api/swiperefresh/
45  - 'Placeholder':
46    - 'Guide': placeholder.md
47    - 'Foundation API': api/placeholder/
48    - 'Material API': api/placeholder-material/
49  - 'Drawable Painter':
50    - 'Guide': drawablepainter.md
51    - 'API': api/drawablepainter/
52  - 'Flow layouts':
53    - 'Guide': flowlayout.md
54    - 'API': api/flowlayout/
55  - 'Permissions':
56    - 'Guide': permissions.md
57    - 'API': api/permissions/
58  - 'Navigation Animation':
59      - 'Guide': navigation-animation.md
60      - 'API': api/navigation-animation/
61  - 'Navigation Material':
62      - 'Guide': navigation-material.md
63      - 'API': api/navigation-material/
64  - 'WebView':
65      - 'Guide': web.md
66      - 'API': api/web/
67  - 'Adaptive':
68      - 'Guide': adaptive.md
69      - 'API': api/adaptive
70  - 'Test Harness':
71      - 'Guide': testharness.md
72      - 'API': api/testharness
73  - 'Snapshots': using-snapshot-version.md
74  - 'Contributing': contributing.md
75  - 'Maintainers':
76    - 'Update guide': updating.md
77
78# Configuration
79theme:
80  name: 'material'
81  language: 'en'
82  icon:
83    logo: material/music-clef-treble
84  palette:
85    primary: 'black'
86    accent: 'deep orange'
87  font:
88    text: 'Roboto'
89    code: 'JetBrains Mono'
90
91# Extensions
92markdown_extensions:
93  - admonition
94  - attr_list
95  - codehilite:
96      guess_lang: false
97  - footnotes
98  - toc:
99      permalink: true
100  - pymdownx.betterem
101  - pymdownx.superfences
102  - pymdownx.tabbed:
103      alternate_style: true
104  - pymdownx.details
105