forked from Amplitude-Developer-Docs/amplitude-dev-center
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
269 lines (254 loc) · 9.12 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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# Project information
site_name: Amplitude Developer Center
site_url: https://docs.developers.amplitude.com
site_author: Amplitude
site_description: >-
Developer resources for Amplitude's digital optimization products.
# Repository
repo_name: amplitude-dev-center
repo_url: https://github.com/Amplitude-Developer-Docs/amplitude-dev-center
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright © 2022 Amplitude
# Configuration
theme:
name: material
custom_dir: overrides
icon:
repo: fontawesome/brands/github
# Static files
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
#- announce.dismiss # this feature is perenially buggy, so keep it disabled unless necessary.
- content.code.annotate
- content.tabs.link
# - header.autohide
# - navigation.expand
- navigation.indexes
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
# - toc.integrate #this is a really noisy feature, IMO.
font: false # Prevents autoloading of google fonts, for privacy reasons.
favicon: assets/favicon.ico
logo: assets/logo.png
extra_css:
- stylesheets/extra.css
extra_javascript:
- /javascripts/accessibe.js # Script for Accessibe. Don't remove without speaking to Legal
- https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
- /javascripts/tablesort.js
# Plugins
# When you add a plugin here, make sure the change is updated in insiders.mkdocs.yml too.
plugins:
- search
- git-revision-date
# Extensions
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- pymdownx.highlight:
anchor_linenums: true
use_pygments: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.snippets
- 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
extra:
support_contact: https://amplitude.com
community: https://community.amplitude.com
help_site: https://help.amplitude.com
training_site: https://academy.amplitude.com/
postman_workspace: https://www.postman.com/amplitude-developer-docs/workspace/amplitude-developers/overview
report_issue: https://github.com/Amplitude-Developer-Docs/amplitude-dev-center/issues
more_resources: all-resources
analytics:
provider: amplitude
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
generator: false #hides the generated with text in the footer
# Navigation
nav:
- Analytics:
- analytics/index.md
- Analytics SDKs:
- Android SDK: analytics/sdks/android-sdk.md
- iOS SDK: analytics/sdks/ios-sdk.md
- Flutter SDK: analytics/sdks/flutter-sdk.md
- JavaScript SDK: analytics/sdks/javascript-sdk.md
- Java SDK: analytics/sdks/java-sdk.md
- Node.js SDK: analytics/sdks/node-sdk.md
- React Native SDK: analytics/sdks/react-native-sdk.md
- Unity SDK: analytics/sdks/unity-sdk.md
- Unreal SDK: analytics/sdks/unreal-sdk.md
- analytics/sdks/android-kotlin-sdk.md
- analytics/sdks/python-sdk.md
- analytics/sdks/typescript-browser-sdk.md
- Analytics API References:
- analytics/apis/attribution-api.md
- analytics/apis/batch-event-upload-api.md
- analytics/apis/behavioral-cohorts-api.md
- analytics/apis/chart-annotations-api.md
- analytics/apis/ccpa-dsar-api.md
- analytics/apis/dashboard-rest-api.md
- analytics/apis/export-api.md
- analytics/apis/group-identify-api.md
- analytics/apis/http-v2-api.md
- analytics/apis/identify-api.md
- analytics/apis/releases-api.md
- analytics/apis/scim-api.md
- analytics/apis/taxonomy-api.md
- analytics/apis/user-privacy-api.md
- Advanced Topics:
- analytics/analytics-domain-proxy.md
- analytics/dynamic-configuration.md
- Other Resources:
- analytics/google-tag-manager.md
- analytics/adobe.md
- Experiment:
- experiment/index.md
- Overview: experiment/index.md
- General:
- experiment/general/data-model.md
- Evaluation:
- Implementation: experiment/general/evaluation/implementation.md
- experiment/general/evaluation/remote-evaluation.md
- Local Evaluation: experiment/general/evaluation/local-evaluation.md
- experiment/general/performance-and-caching.md
- experiment/general/exposure-tracking.md
- Guides:
- Getting Started:
- experiment/guides/getting-started/create-a-deployment.md
- experiment/guides/getting-started/create-a-flag.md
- experiment/guides/getting-started/fetch-variants.md
- experiment/guides/getting-started/track-exposure.md
- experiment/guides/server-side-rendering.md
- experiment/guides/create-local-evaluation-flag.md
- SDKs:
- JavaScript SDK: experiment/sdks/javascript-sdk.md
- Android SDK: experiment/sdks/android-sdk.md
- iOS SDK: experiment/sdks/ios-sdk.md
- React Native SDK: experiment/sdks/react-native-sdk.md
- Node.js SDK: experiment/sdks/nodejs-sdk.md
- Go SDK (Beta): experiment/sdks/go-sdk.md
- REST APIs:
- Evaluation API: "https://developers.experiment.amplitude.com/reference/get_v1-vardata"
- Management API (Beta): "https://developers.experiment.amplitude.com/reference/management-api"
# - Remove / Move:
# - experiment/sdks/beta-migration.md
# - Concepts:
# - experiment/remove-move/concepts/index.md
# - experiment/remove-move/concepts/experiment-user.md
# - experiment/remove-move/concepts/experiment-sdk-configuration.md
# - experiment/remove-move/concepts/experiment-variants.md
# - Local Evaluation (Alpha):
# - experiment/remove-move/local-evaluation/local-evaluation-overview.md
# - experiment/remove-move/local-evaluation/create-a-local-evaluation-flag.md
# - experiment/remove-move/local-evaluation/nodejs-sdk.md
- Data (Beta):
- data/index.md
- Data Instrumentation:
- data/ampli-sdk-overview.md
- data/using-the-ampli-cli.md
- data/using-the-tracking-library.md
- data/integrating-with-ci.md
- data/user-lookup.md
- data/git-workflow.md
- data/middleware-overview.md
- data/migrate-to-data.md
- Data SDKs:
- data/sdks/browser-ampli.md
- data/sdks/nodejs-ampli.md
- data/sdks/ios-ampli.md
- data/sdks/android-ampli.md
- data/sdks/jre-ampli.md
- Reverse ETL and Cloud Integrations:
- Amazon S3:
- S3 Import: integrations/amazon-s3-import.md
- S3 Export: integrations/amazon-s3-export.md
- BigQuery:
- BigQuery Import: integrations/bigquery-import.md
- BigQuery Export: integrations/bigquery-export.md
- Google Cloud Storage (GCS):
- GCS Import: integrations/google-cloud-storage-import.md
- GCS Export: integrations/google-cloud-storage-export.md
- Redshift:
- Redshift Export: integrations/redshift-export.md
- Snowflake:
- Snowflake Import: integrations/snowflake-import.md
- Snowflake Export: integrations/snowflake-export.md
- integrations/converter-configuration-reference.md
- Event Streaming Integrations:
- Braze (Beta): integrations/braze-event-streaming.md
- Pub/Sub (Beta): integrations/google-pub-sub-event-streaming.md
- Intercom (Beta): integrations/intercom-event-streaming.md
- Iterable (Beta): integrations/iterable-event-streaming.md
- Kinesis Data Stream (Beta): integrations/kinesis-data-stream-event-streaming.md
- Kinesis Firehose (Beta): integrations/kinesis-firehose-event-streaming.md
- Other Integrations:
- integrations/shopify-plugin.md
- integrations/sending-cohorts.md
- Resources:
- all-resources.md
#- Partner Hub: # Hidden until we have content
#- partners/index.md
# Files Intentionally left out of nav:
#- Data Docs (Deprecated): These are excluded on purpose please don't add them to nav
#- data/deprecated-sdks/browser.md
#- data/deprecated-sdks/nodejs.md
#- data/deprecated-sdks/ios.md
#- data/deprecated-sdks/android.md
#- data/deprecated-sdks/jre.md
#- data/deprecated-sdks/python.md
#- data/deprecated-sdks/ruby.md
#- data/deprecated-sdks/dotnet.md
#- data/deprecated-sdks/jre-v3.md
#- data/deprecated-sdks/ruby-v2.md
#- data/iglu-api.md