-
Notifications
You must be signed in to change notification settings - Fork 36
/
mkdocs.yml
147 lines (142 loc) · 6.48 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
# Site
site_name: 'Contacts, Reborn'
site_description: 'Android Contacts API Library for Kotlin and Java.'
site_author: 'Vandolf Estrellado'
site_url: 'https://vestrel00.github.io/contacts-android/'
# Repository
repo_name: 'vestrel00/contacts-android'
repo_url: 'https://github.com/vestrel00/contacts-android'
edit_uri: 'tree/main/docs/'
remote_branch: gh-pages
# Navigation
nav:
- 'Overview': index.md
- 'Cheatsheet': cheatsheet.md
- 'Setup':
- 'Installation': setup/installation.md
- 'Contacts API Setup': setup/setup-contacts-api.md
- 'Entities':
- 'API entities': entities/about-api-entities.md
- 'Blank contacts': entities/about-blank-contacts.md
- 'Blank data': entities/about-blank-data.md
- 'Local (device-only) contacts': entities/about-local-contacts.md
- 'Contact lookup key vs ID': entities/about-contact-lookup-key.md
- 'Sync contact data across devices': entities/sync-contact-data.md
- 'Redact entities and API input and output in production': entities/redact-apis-and-entities.md
- 'Basics':
- 'Query contacts': basics/query-contacts.md
- 'Query contacts (advanced)': basics/query-contacts-advanced.md
- 'Query contacts by phone or SIP': basics/query-contacts-by-phone-or-sip.md
- 'Query RawContacts': basics/query-raw-contacts.md
- 'Insert contacts': basics/insert-contacts.md
- 'Update contacts': basics/update-contacts.md
- 'Delete contacts': basics/delete-contacts.md
- 'Include only certain fields for read and write operations': basics/include-only-desired-data.md
- 'Using limit and offset in queries': basics/limit-and-offset-queries.md
- 'Data':
- 'Query specific data kinds': data/query-data-sets.md
- 'Insert data into new or existing contacts': data/insert-data-sets.md
- 'Update existing sets of data': data/update-data-sets.md
- 'Delete existing sets of data': data/delete-data-sets.md
- 'Custom data':
- 'Query custom data': customdata/query-custom-data.md
- 'Insert custom data into new or existing contacts': customdata/insert-custom-data.md
- 'Update custom data': customdata/update-custom-data.md
- 'Delete custom data': customdata/delete-custom-data.md
- 'Integrate custom data': customdata/integrate-custom-data.md
- 'Integrate custom data from other apps': customdata/integrate-custom-data-from-other-apps.md
- 'Integrate the Google Contacts custom data': customdata/integrate-googlecontacts-custom-data.md
- 'Integrate the Gender custom data': customdata/integrate-gender-custom-data.md
- 'Integrate the Handle Name custom data': customdata/integrate-handlename-custom-data.md
- 'Integrate the Pokemon custom data': customdata/integrate-pokemon-custom-data.md
- 'Integrate the RPG custom data': customdata/integrate-rpg-custom-data.md
- 'Groups':
- 'Query groups': groups/query-groups.md
- 'Insert groups': groups/insert-groups.md
- 'Update groups': groups/update-groups.md
- 'Delete groups': groups/delete-groups.md
- 'Profile':
- 'Query device owner Contact profile': profile/query-profile.md
- 'Insert device owner Contact profile': profile/insert-profile.md
- 'Update device owner Contact profile': profile/update-profile.md
- 'Delete device owner Contact profile': profile/delete-profile.md
- 'Accounts':
- 'Query for Accounts': accounts/query-accounts.md
- 'Move RawContacts across Accounts': accounts/move-raw-contacts-across-accounts.md
- 'SIM card':
- 'About SIM contacts': sim/about-sim-contacts.md
- 'Query contacts in SIM card': sim/query-sim-contacts.md
- 'Insert contacts into SIM card': sim/insert-sim-contacts.md
- 'Update contacts in SIM card': sim/update-sim-contacts.md
- 'Delete contacts from SIM card': sim/delete-sim-contacts.md
- 'Blocked numbers':
- 'About blocked numbers': blockednumbers/about-blocked-numbers.md
- 'Query blocked numbers': blockednumbers/query-blocked-numbers.md
- 'Insert blocked numbers': blockednumbers/insert-blocked-numbers.md
- 'Delete blocked numbers': blockednumbers/delete-blocked-numbers.md
- 'Permissions':
- 'Permissions handling using coroutines': permissions/permissions-handling-coroutines.md
- 'Asynchronous work':
- 'Execute work outside of the UI thread using coroutines': async/async-execution-coroutines.md
- 'UI':
- 'Integrate rudimentary contacts ui components': ui/integrate-rudimentary-contacts-integrated-ui-components.md
- 'Other':
- 'Get set remove full-sized and thumbnail contact photos': other/get-set-remove-contact-raw-contact-photo.md
- 'Get set contact options': other/get-set-clear-contact-raw-contact-options.md
- 'Get set clear default Contact data': other/get-set-clear-default-data.md
- 'Link unlink Contacts': other/link-unlink-contacts.md
- 'Share Contacts vCard (.VCF)': other/share-contacts-vcard.md
- 'Convenience functions': other/convenience-functions.md
- 'Logging':
- 'Log API input and output': logging/log-api-input-output.md
- 'Testing':
- 'Contacts API Testing': testing/test-contacts-api.md
- 'Debug':
- 'Debug the Contacts Provider tables': debug/debug-contacts-provider-tables.md
- 'Debug the BlockedNumber Provider tables': debug/debug-blockednumber-provider-tables.md
- 'Debug the Sim Contacts table': debug/debug-sim-contacts-tables.md
- 'Contributing': contributing.md
- 'Developer notes': dev-notes.md
# Theme
theme:
name: 'material'
language: 'en'
favicon: assets/images/favicon.png
icon:
logo: material/contacts
repo: fontawesome/brands/github
font:
text: 'Roboto'
code: 'JetBrains Mono'
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: 'deep orange'
accent: 'red'
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: 'deep orange'
accent: 'red'
toggle:
icon: material/toggle-switch
name: Switch to light mode
# Plugins
plugins:
- search
# Extensions
markdown_extensions:
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=toc#table-of-contents
- toc:
permalink: true
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
# https://squidfunk.github.io/mkdocs-material/reference/content-tabs
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true