_config.yml

# 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: your-email@example.com
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/
  - node_modules


# Build settings
markdown: kramdown
kramdown:
  parse_block_html: true
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: Toolchain
              item_external_url: 'https://aws-amplify.github.io/media/toolchain'
              id: cli
            - 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
exclude: [ 'README.md', 'CHANGELOG.md' ]
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: Toolchain
      title: Toolchain
      excerpt: Better developer experience when building and deploying your apps.
      base_url: '/cli/'
      subs:
        - title: Usage
          excerpt: Setup and Configure a Project with the CLI
          url: '/cli/init?sdk=android'
          icon: '/images/icons/Misc/Present.svg'
        - title: Architecture
          excerpt: CLI Architecture and Overview
          url: '/cli/concept?sdk=android'
          icon: '/images/icons/Misc/Present.svg'
        - title: Codegen
          excerpt: Codegen for GraphQL
          url: '/cli/codegen?sdk=android' 
          icon: '/images/icons/Misc/Present.svg'
        - title: Plugins
          excerpt: Create a new plugin for the CLI
          url: '/cli/plugins?sdk=android' 
          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/graphql?sdk=android'
        - title: Environments & Teams
          excerpt: Setup multiple enviornments for your app and work with teams on your app.
          url: '/cli/multienv?sdk=android'
          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: Push Notifications
          excerpt: Push notifications with campaign analytics and targeting.
          cta: Read more
          class: aws-icon-ps-60-device-message
          url: '/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: '/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: Manual SDK Setup
          excerpt: Setup Options for the SDK
          cta: Read more
          class: aws-icon-ps-60-circular-circuit
          url: '/android/manualsetup'

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: Toolchain
      title: Toolchain
      excerpt: Better developer experience when building and deploying your apps.
      base_url: '/cli/'
      subs:
        - title: Usage
          excerpt: Setup and Configure a Project with the CLI
          url: '/cli/init?sdk=ios'
          icon: '/images/icons/Misc/Present.svg'
        - title: Architecture
          excerpt: CLI Architecture and Overview
          url: '/cli/concept?sdk=ios'
          icon: '/images/icons/Misc/Present.svg'
        - title: Codegen
          excerpt: Codegen for GraphQL
          url: '/cli/codegen?sdk=ios' 
          icon: '/images/icons/Misc/Present.svg'
        - title: Plugins
          excerpt: Create a new plugin for the CLI
          url: '/cli/plugins?sdk=ios' 
          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/graphql?sdk=ios'
        - title: Environments & Teams
          excerpt: Setup multiple enviornments for your app and work with teams on your app.
          url: '/cli/multienv?sdk=ios'
          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: Push Notifications
          excerpt: Push notifications with campaign analytics and targeting.
          cta: Read more
          class: aws-icon-ps-60-device-message
          url: '/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: '/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: Manual SDK Setup
          excerpt: Setup Options for the SDK
          cta: Read more
          class: aws-icon-ps-60-circular-circuit
          url: '/ios/manualsetup'

category_list:
    - category: SetupAndInstallation
      title: Setup & Installation
      excerpt:
      base_url: '/js/start'
      subs:
        - title: Getting Started
          excerpt: get started excerpt
          url: '/js/start'
          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: Toolchain
      title: Toolchain
      excerpt: Better developer experience when building and deploying your apps.
      base_url: '/cli/'
      subs:
        - title: Usage
          excerpt: Setup and Configure a Project with the CLI
          url: '/cli/init?sdk=js'
          icon: '/images/icons/Misc/Present.svg'
        - title: Architecture
          excerpt: CLI Architecture and Overview
          url: '/cli/concept?sdk=js'
          icon: '/images/icons/Misc/Present.svg'
        - title: Hosting
          excerpt: Host your web project or static assets
          url: '/cli/hosting?sdk=js' 
          icon: '/images/icons/Misc/Present.svg'
        - title: Codegen
          excerpt: Codegen for GraphQL
          url: '/cli/codegen?sdk=js' 
          icon: '/images/icons/Misc/Present.svg'
        - title: Plugins
          excerpt: Create a new plugin for the CLI
          url: '/cli/plugins?sdk=js' 
          icon: '/images/icons/Misc/Present.svg'
        - title: UI Components
          excerpt: User interface components
          url: '/js/ui'
          icon: '/images/icons/Misc/Present.svg'
        - title: VS Code Extension
          excerpt: Code snippets for AWS Amplify in Visual Studio Code.
          cta: Read more
          class: aws-icon-ps-60-network-nodes
          url_external: 'https://marketplace.visualstudio.com/items?itemName=aws-amplify.aws-amplify-vscode'
          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/graphql?sdk=js'
        - title: Environments & Teams
          excerpt: Setup multiple enviornments for your app and work with teams on your app.
          url: '/cli/multienv?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: 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: 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'