forked from aws-amplify/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
_config.yml
860 lines (838 loc) · 32.1 KB
/
_config.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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: AWS Amplify Developer Documentation
email: [email protected]
description: >- # this means to ignore newlines until "baseurl:"
AWS Amplify is a JavaScript library for frontend and mobile developers building cloud-enabled applications.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
github:
repository_url: https://github.com/aws-amplify/docs
show_downloads: "true"
include:
- api
- api/assets
- api/classes
- api/enums
- api/interfaces
- api/modules
# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
exclude:
- Gemfile
- Gemfile.lock
- node_modules/
- vendor/bundle/
- vendor/cache/
- vendor/gems/
- vendor/ruby/
- Readme.md
# Build settings
markdown: kramdown
kramdown:
parse_block_html: true
syntax_highlighter: rouge
plugins:
- jekyll-feed
- jekyll-sitemap
- jekyll-redirect-from
future: true
# Amplify theme settings
amplify:
baseurl: /docs
docs_baseurl: /docs
color_theme: # Available themes: blue (default), green, purple, red and yellow
marketing_site_home: 'https://aws-amplify.github.io/'
marketing_site_get_started: 'https://aws-amplify.github.io/media/get_started'
marketing_site_toolchain: 'https://aws-amplify.github.io/media/toolchain'
marketing_site_ui: 'https://aws-amplify.github.io/media/ui_library'
api_js_url: 'https://aws-amplify.github.io/amplify-js/api/'
header:
logo:
text: Amplify Framework
cli_text: 'Amplify'
js_text: 'Amplify JavaScript'
android_text: 'Android SDK'
ios_text: 'iOS SDK'
image: true
platform: for JavaScript
nav:
- item_name: Get Started
item_url: '/'
id: get_started
- item_name: Style Guide
item_external_url: 'https://aws-amplify.github.io/media/ui_library'
id: ui
ios:
theme: 'dark'
footer:
content:
logo:
text: AWS Amplify is supported by Amazon Web Services
image: true
copyright: © 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
social_list:
- network_name: gitter
profile_url: 'https://gitter.im/AWS-Amplify/Lobby/'
- network_name: github
profile_url: 'https://github.com/aws-amplify/amplify-js'
- network_name: twitter
profile_url: 'https://twitter.com/search?q=%23awsamplify&src=typd'
- network_name: youtube
profile_url: 'https://www.youtube.com/watch?v=vAjf3lyjf8c'
google_analytics:
tracking_code: # Add your Google Analytics tracking code to activate Google Analytics
comments:
disqus_forum_shortname: 'aws-amplify' # Add your disqus forum shortname to activate comments
# SASS settings
sass:
sass_dir: ./theme/_sass
style: :compressed
# Jekyll settings
layouts_dir: ./theme/_layouts
includes_dir: ./theme/_includes
permalink: /:title
android_category_list:
- category: SetupAndInstallation
title: Setup & Installation
excerpt:
base_url: '/android/start'
subs:
- title: Getting Started
excerpt: get started excerpt
url: '/android/start'
icon: '/images/icons/Misc/Present.svg'
- category: CLI Toolchain
title: CLI Toolchain
excerpt: Better developer experience when building and deploying your apps.
base_url: '/cli-toolchain/'
subs:
- title: Quickstart
excerpt: Setup and Configure a Project with the CLI
url: '/cli-toolchain/quickstart?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: Usage
excerpt: CLI Architecture and Overview
url: '/cli-toolchain/usage?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: GraphQL Transform
excerpt: Transform simple GraphQL schema files into full application backends.
cta: Read more
class: aws-icon-ps-60-network-nodes
icon: '/images/icons/Misc/Tool.svg'
url: '/cli-toolchain/graphql?sdk=js'
- title: Plugins & Extensions
excerpt: Create a new plugin for the CLI
url: '/cli-toolchain/plugins?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- category: API Guides
title: API Guides
excerpt: Add cloud features to your app quickly using our toolchain and declarative APIs.
base_url: '/android/analytics'
subs:
- title: API
excerpt: A simple and secure solution for making HTTP requests using REST and GraphQL, with support for real-time data.
cta: Read more
class: aws-icon-ps-60-database-server
url: '/android/api'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon API Gateway,
url: https://aws.amazon.com/api-gateway
- title: AWS AppSync
url: https://aws.amazon.com/appsync
- title: Storage
excerpt: A simple mechanism for managing user content in public, protected or private storage.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/android/storage'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon S3
url: https://aws.amazon.com/s3/
- title: Authentication
excerpt: Authentication APIs with pre-built UI components for your app.
cta: Read more
class: aws-icon-ps-60-shield-circle
url: '/android/authentication'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Cognito,
url: https://aws.amazon.com/cognito/
- title: OAuth 2.0 ,
url: https://aws.amazon.com/cognito/
- title: Custom Plugin
url:
- title: Analytics
excerpt: Drop-in analytics to track user sessions, custom user attributes, and in-app metrics.
cta: Read more
class: aws-icon-ps-60-pie-bar-charts
url: '/android/analytics'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint,
url: https://aws.amazon.com/pinpoint/
- title: Amazon Kinesis,
url: https://aws.amazon.com/kinesis/
- title: Custom Plugin
url: https://aws-amplify.github.io/amplify-js/media/analytics_guide#using-a-custom-plugin
- title: DataStore
excerpt: On-device persistent storage.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/android/datastore'
icon: '/images/icons/Misc/Cloud.svg'
- category: Manual SDK Configuration
title: SDK Configuration
excerpt: Low level config
base_url: '/android/manualsetup'
subs:
- title: SDK Setup Options
excerpt: Setup Options for the SDK
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/android/manualsetup'
- category: Docs version
title: Docs version
excerpt: Version of the docs
version: amplify1.0
subs:
- title: Amplify Android
excerpt: Version of the docs
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/android/start'
- title: Android SDK 2.0
excerpt: Version of the docs
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/sdk/android/start'
android_category_list_sdk:
- category: SetupAndInstallation
title: Setup & Installation
excerpt:
base_url: '/sdk/android/start'
subs:
- title: Getting Started
excerpt: get started excerpt
url: '/sdk/android/start'
icon: '/images/icons/Misc/Present.svg'
- category: CLI Toolchain
title: CLI Toolchain
excerpt: Better developer experience when building and deploying your apps.
base_url: '/cli-toolchain/'
subs:
- title: Quickstart
excerpt: Setup and Configure a Project with the CLI
url: '/cli-toolchain/quickstart?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: Usage
excerpt: CLI Architecture and Overview
url: '/cli-toolchain/usage?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: GraphQL Transform
excerpt: Transform simple GraphQL schema files into full application backends.
cta: Read more
class: aws-icon-ps-60-network-nodes
icon: '/images/icons/Misc/Tool.svg'
url: '/cli-toolchain/graphql?sdk=js'
- title: Plugins & Extensions
excerpt: Create a new plugin for the CLI
url: '/cli-toolchain/plugins?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- category: API Guides
title: API Guides
excerpt: Add cloud features to your app quickly using our toolchain and declarative APIs.
base_url: '/android/analytics'
subs:
- title: API
excerpt: A simple and secure solution for making HTTP requests using REST and GraphQL, with support for real-time data.
cta: Read more
class: aws-icon-ps-60-database-server
url: '/sdk/android/api'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon API Gateway,
url: https://aws.amazon.com/api-gateway
- title: AWS AppSync
url: https://aws.amazon.com/appsync
- title: Storage
excerpt: A simple mechanism for managing user content in public, protected or private storage.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/sdk/android/storage'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon S3
url: https://aws.amazon.com/s3/
- title: Authentication
excerpt: Authentication APIs with pre-built UI components for your app.
cta: Read more
class: aws-icon-ps-60-shield-circle
url: '/sdk/android/authentication'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Cognito,
url: https://aws.amazon.com/cognito/
- title: OAuth 2.0 ,
url: https://aws.amazon.com/cognito/
- title: Custom Plugin
url:
- title: Analytics
excerpt: Drop-in analytics to track user sessions, custom user attributes, and in-app metrics.
cta: Read more
class: aws-icon-ps-60-pie-bar-charts
url: '/sdk/android/analytics'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint,
url: https://aws.amazon.com/pinpoint/
- title: Amazon Kinesis,
url: https://aws.amazon.com/kinesis/
- title: Custom Plugin
url: https://aws-amplify.github.io/amplify-js/media/analytics_guide#using-a-custom-plugin
- title: Push Notifications
excerpt: Push notifications with campaign analytics and targeting.
cta: Read more
class: aws-icon-ps-60-device-message
url: '/sdk/android/push-notifications'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint
url: https://aws.amazon.com/pinpoint/
- title: PubSub
excerpt: Connect your app to message-oriented middleware on the cloud.
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/sdk/android/pubsub'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: AWS IoT,
url: https://aws.amazon.com/iot/
- title: Generic MQTT,
url: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#mqtt
- title: Custom Plugin
url:
- category: Manual SDK Configuration
title: SDK Configuration
excerpt: Low level config
base_url: '/android/manualsetup'
subs:
- title: SDK Setup Options
excerpt: Setup Options for the SDK
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/android/manualsetup'
- category: Docs version
title: Docs version
excerpt: Version of the docs
version: amplify1.0
subs:
- title: Amplify Android
excerpt: Version of the docs
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/android/start'
- title: Android SDK 2.0
excerpt: Version of the docs
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/sdk/android/start'
ios_category_list:
- category: SetupAndInstallation
title: Setup & Installation
excerpt:
base_url: '/ios/start'
subs:
- title: Getting Started
excerpt: get started excerpt
url: '/ios/start'
icon: '/images/icons/Misc/Present.svg'
- category: CLI Toolchain
title: CLI Toolchain
excerpt: Better developer experience when building and deploying your apps.
base_url: '/cli-toolchain/'
subs:
- title: Quickstart
excerpt: Setup and Configure a Project with the CLI
url: '/cli-toolchain/quickstart?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: Usage
excerpt: CLI Architecture and Overview
url: '/cli-toolchain/usage?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: GraphQL Transform
excerpt: Transform simple GraphQL schema files into full application backends.
cta: Read more
class: aws-icon-ps-60-network-nodes
icon: '/images/icons/Misc/Tool.svg'
url: '/cli-toolchain/graphql?sdk=js'
- title: Plugins & Extensions
excerpt: Create a new plugin for the CLI
url: '/cli-toolchain/plugins?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- category: API Guides
title: API Guides
excerpt: Add cloud features to your app quickly using our toolchain and declarative APIs.
base_url: '/ios/analytics'
subs:
- title: API
excerpt: A simple and secure solution for making HTTP requests using REST and GraphQL, with support for real-time data.
cta: Read more
class: aws-icon-ps-60-database-server
url: '/ios/api'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon API Gateway,
url: https://aws.amazon.com/api-gateway
- title: AWS AppSync
url: https://aws.amazon.com/appsync
- title: Storage
excerpt: A simple mechanism for managing user content in public, protected or private storage.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/ios/storage'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon S3
url: https://aws.amazon.com/s3/
- title: Authentication
excerpt: Authentication APIs with pre-built UI components for your app.
cta: Read more
class: aws-icon-ps-60-shield-circle
url: '/ios/authentication'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Cognito,
url: https://aws.amazon.com/cognito/
- title: OAuth 2.0 ,
url: https://aws.amazon.com/cognito/
- title: Custom Plugin
url:
- title: Analytics
excerpt: Drop-in analytics to track user sessions, custom user attributes, and in-app metrics.
cta: Read more
class: aws-icon-ps-60-pie-bar-charts
url: '/ios/analytics'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint,
url: https://aws.amazon.com/pinpoint/
- title: Amazon Kinesis,
url: https://aws.amazon.com/kinesis/
- title: Custom Plugin
url: https://aws-amplify.github.io/amplify-js/media/analytics_guide#using-a-custom-plugin
- title: DataStore
excerpt: On-device persistent storage.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/ios/datastore'
icon: '/images/icons/Misc/Cloud.svg'
- title: Predictions
excerpt: Add AI/ML capabilities to your app powered by cloud services.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/ios/predictions'
icon: '/images/icons/Misc/Cloud.svg'
- category: Manual SDK Configuration
title: SDK Configuration
excerpt: Low level config
base_url: '/ios/manualsetup'
subs:
- title: SDK Setup Options
excerpt: Setup Options for the SDK
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/ios/manualsetup'
- category: Docs version
title: Docs version
excerpt: Version of the docs
version: amplify1.0
subs:
- title: Amplify iOS
excerpt: Version of the docs
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/ios/start'
- title: iOS SDK 2.0
excerpt: Version of the docs
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/sdk/ios/start'
ios_category_list_sdk:
- category: SetupAndInstallation
title: Setup & Installation
excerpt:
base_url: '/sdk/ios/start'
subs:
- title: Getting Started
excerpt: get started excerpt
url: '/sdk/ios/start'
icon: '/images/icons/Misc/Present.svg'
- category: CLI Toolchain
title: CLI Toolchain
excerpt: Better developer experience when building and deploying your apps.
base_url: '/cli-toolchain/'
subs:
- title: Quickstart
excerpt: Setup and Configure a Project with the CLI
url: '/cli-toolchain/quickstart?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: Usage
excerpt: CLI Architecture and Overview
url: '/cli-toolchain/usage?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: GraphQL Transform
excerpt: Transform simple GraphQL schema files into full application backends.
cta: Read more
class: aws-icon-ps-60-network-nodes
icon: '/images/icons/Misc/Tool.svg'
url: '/cli-toolchain/graphql?sdk=js'
- title: Plugins & Extensions
excerpt: Create a new plugin for the CLI
url: '/cli-toolchain/plugins?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- category: API Guides
title: API Guides
excerpt: Add cloud features to your app quickly using our toolchain and declarative APIs.
base_url: '/sdk/ios/api'
subs:
- title: API
excerpt: A simple and secure solution for making HTTP requests using REST and GraphQL, with support for real-time data.
cta: Read more
class: aws-icon-ps-60-database-server
url: '/sdk/ios/api'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon API Gateway,
url: https://aws.amazon.com/api-gateway
- title: AWS AppSync
url: https://aws.amazon.com/appsync
- title: Storage
excerpt: A simple mechanism for managing user content in public, protected or private storage.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/sdk/ios/storage'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon S3
url: https://aws.amazon.com/s3/
- title: Authentication
excerpt: Authentication APIs with pre-built UI components for your app.
cta: Read more
class: aws-icon-ps-60-shield-circle
url: '/sdk/ios/authentication'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Cognito,
url: https://aws.amazon.com/cognito/
- title: OAuth 2.0 ,
url: https://aws.amazon.com/cognito/
- title: Custom Plugin
url:
- title: Analytics
excerpt: Drop-in analytics to track user sessions, custom user attributes, and in-app metrics.
cta: Read more
class: aws-icon-ps-60-pie-bar-charts
url: '/sdk/ios/analytics'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint,
url: https://aws.amazon.com/pinpoint/
- title: Amazon Kinesis,
url: https://aws.amazon.com/kinesis/
- title: Custom Plugin
url: https://aws-amplify.github.io/amplify-js/media/analytics_guide#using-a-custom-plugin
- title: Push Notifications
excerpt: Push notifications with campaign analytics and targeting.
cta: Read more
class: aws-icon-ps-60-device-message
url: '/sdk/ios/push-notifications'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint
url: https://aws.amazon.com/pinpoint/
- title: PubSub
excerpt: Connect your app to message-oriented middleware on the cloud.
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/sdk/ios/pubsub'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: AWS IoT,
url: https://aws.amazon.com/iot/
- title: Generic MQTT,
url: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#mqtt
- title: Custom Plugin
url:
- category: Manual SDK Configuration
title: SDK Configuration
excerpt: Low level config
base_url: '/ios/manualsetup'
subs:
- title: SDK Setup Options
excerpt: Setup Options for the SDK
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/ios/manualsetup'
- category: Docs version
title: Docs version
excerpt: Version of the docs
version: amplify1.0
##base_url: '/ios/start'
subs:
- title: Amplify iOS
excerpt: Version of the docs
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/ios/start'
- title: iOS SDK 2.0
excerpt: Version of the docs
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/sdk/ios/start'
category_list:
- category: SetupAndInstallation
title: Setup & Installation
excerpt:
base_url: '/js/start'
subs:
- title: Getting Started
excerpt: get started excerpt
url: '/js/start?platform=purejs'
icon: '/images/icons/Misc/Present.svg'
- category: Tutorials
title: Framework Support
excerpt:
base_url: '/js/react'
subs:
- title: React & React Native
excerpt: #'A step-by-step tutorial for learning how to build a cloud-enabled React Web app with AWS Amplify.<br/><b>30 min to complete</b>'
url: '/js/react'
icon: '/images/icons/Misc/Present.svg'
- title: Angular & Ionic
excerpt: #"Learn to build a cloud enabled 'Notes App' with Ionic 4 and AWS Amplify <br/><b>45 min to complete</b>"
url: '/js/angular'
icon: '/images/icons/Misc/Present.svg'
- title: Vue
excerpt: #"Learn to build a cloud enabled App with Vue.js and AWS Amplify <br/><b>45 min to complete</b>"
url: '/js/vue'
icon: '/images/icons/Misc/Present.svg'
- category: CLI Toolchain
title: CLI Toolchain
excerpt: Better developer experience when building and deploying your apps.
base_url: '/cli-toolchain/'
subs:
- title: Quickstart
excerpt: Setup and Configure a Project with the CLI
url: '/cli-toolchain/quickstart?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: Usage
excerpt: CLI Architecture and Overview
url: '/cli-toolchain/usage?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- title: GraphQL Transform
excerpt: Transform simple GraphQL schema files into full application backends.
cta: Read more
class: aws-icon-ps-60-network-nodes
icon: '/images/icons/Misc/Tool.svg'
url: '/cli-toolchain/graphql?sdk=js'
- title: Plugins & Extensions
excerpt: Create a new plugin for the CLI
url: '/cli-toolchain/plugins?sdk=js'
icon: '/images/icons/Misc/Present.svg'
- category: Categories
title: API Guides
excerpt: Add cloud features to your app quickly using our toolchain and declarative APIs.
base_url: '/js/analytics'
subs:
- title: Analytics
excerpt: Drop-in analytics to track user sessions, custom user attributes, and in-app metrics.
cta: Read more
class: aws-icon-ps-60-pie-bar-charts
url: '/js/analytics'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint,
url: https://aws.amazon.com/pinpoint/
- title: Amazon Kinesis,
url: https://aws.amazon.com/kinesis/
- title: Custom Plugin
url: https://aws-amplify.github.io/amplify-js/media/analytics_guide#using-a-custom-plugin
- title: API
excerpt: A simple and secure solution for making HTTP requests using REST and GraphQL, with support for real-time data.
cta: Read more
class: aws-icon-ps-60-database-server
url: '/js/api'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon API Gateway,
url: https://aws.amazon.com/api-gateway
- title: AWS AppSync
url: https://aws.amazon.com/appsync
- title: Authentication
excerpt: Authentication APIs with pre-built UI components for your app.
cta: Read more
class: aws-icon-ps-60-shield-circle
url: '/js/authentication'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Cognito,
url: https://aws.amazon.com/cognito/
- title: OAuth 2.0 ,
url: https://aws.amazon.com/cognito/
- title: Custom Plugin
url:
- title: DataStore
excerpt: persistent on-device storage repository for you to write, read, and observe changes to data if you are online or offline
cta: Read more
class: aws-icon-ps-60-shield-circle
url: '/js/datastore'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: AWS AppSync
url: https://aws.amazon.com/appsync
- title: Interactions
excerpt: Create conversational bots powered by deep learning technologies.
cta: Read more
class: aws-icon-ps-60-bubble-gear
url: '/js/interactions'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Lex
url: https://aws.amazon.com/lex/
- title: Predictions
excerpt: Add AI and ML capabilities to your app using the cloud
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/js/predictions'
icon: '/images/icons/Misc/Cloud.svg'
- title: PubSub
excerpt: Connect your app to message-oriented middleware on the cloud.
cta: Read more
class: aws-icon-ps-60-circular-circuit
url: '/js/pubsub'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: AWS IoT,
url: https://aws.amazon.com/iot/
- title: Generic MQTT,
url: https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#mqtt
- title: Custom Plugin
url:
- title: Push Notifications
excerpt: Push notifications with campaign analytics and targeting.
cta: Read more
class: aws-icon-ps-60-device-message
url: '/js/push-notifications'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon Pinpoint
url: https://aws.amazon.com/pinpoint/
- title: Storage
excerpt: A simple mechanism for managing user content in public, protected or private storage.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/js/storage'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon S3
url: https://aws.amazon.com/s3/
- title: XR
excerpt: Build AR/VR enabled web applications.
cta: Read more
class: aws-icon-ps-60-file-box
url: '/js/xr'
icon: '/images/icons/Misc/Cloud.svg'
services:
- title: Amazon S3
url: https://aws.amazon.com/s3/
- category: Utilities
title: Utilities
excerpt: Common programming utilities that you can use with your app.
base_url: '/js/cache'
subs:
- title: Service Worker
excerpt: A utility class to work with PWA and Service Worker APIs.
cta: Read more
url: '/js/service-workers'
icon: '/images/icons/Misc/Gear.svg'
- title: Cache
excerpt: A generic LRU cache for storing data with priority and expiration settings.
cta: Read more
url: '/js/cache'
icon: '/images/icons/Misc/Gear.svg'
- title: Hub
excerpt: A lightweight local event bus for your app.
cta: Read more
url: '/js/hub'
icon: '/images/icons/Misc/Gear.svg'
- title: I18n
excerpt: A lightweight internationalization solution.
cta: Read more
url: '/js/i18n'
icon: '/images/icons/Misc/Gear.svg'
- title: Logger
excerpt: Console logging utility.
cta: Read more
url: '/js/logger'
icon: '/images/icons/Misc/Gear.svg'
defaults:
-
scope:
path: "" # an empty string here means all files in the project
values:
layout: "default"
examples:
- title: Web apps
url: 'web-apps'
- title: React Native apps
url: 'react-native-apps'
- title: Hybrid Mobile
url: 'hybrid-mobile-apps'
- title: Static Websites
url: 'static-web-sites'
- title: Code Examples
url: 'examples'
styleguide:
- title: Colors
url: '#colors'
- title: 'Typography'
url: '#typography'
#- title: 'Controls'
# url: '#controls--inputs'
#- title: 'Widgets'
# url: '#widgets'
- title: Components
url: '#aws-components'
js_libraries:
- title: React
url: '?platform=react'
- title: React Native
url: '?platform=react-native'
- title: Angular
url: '?platform=angular'
- title: Ionic
url: '?platform=ionic'
- title: JavaScript
url: '?platform=purejs'
- title: Vue
url: '?platform=vue'
android_languages:
- title: Java
url: '?platform=java'
- title: Kotlin
url: '?platform=kotlin'