mkdocs.yml

# Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: Developer Portal
site_url: https://tigergraph-oss.github.io/tg-ecosys-docs/
site_author: Jon Herke
site_description: >-
  TigerGraph is dedicated to providing the community 
  with all the essential in-house and community-developed 
  tools to get the most value out of your TigerGraph solutions

# Repository
repo_name: tigergraph/ecosys
repo_url: https://github.com/tigergraph/ecosys
edit_uri: ""

# Copyright
copyright: Copyright &copy; 2020 TigerGraph

# Configuration
theme:
  name: null
  custom_dir: material

  # 404 page
  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:
    - tabs
    #- instant
  palette:
    scheme: default
    primary: deep-orange
    accent: light-blue
  font:
    text: Roboto 
    code: Roboto Mono
  favicon: assets/favicon.png
  icon:
    logo: logo

# Plugins
plugins:
  - search
  # - redirects:
  #     redirect_maps:
  #       extensions/admonition.md: reference/admonitions.md
  #       extensions/codehilite.md: reference/code-blocks.md
  #       extensions/footnotes.md: reference/footnotes.md
  #       extensions/metadata.md: reference/meta-tags.md
  #       extensions/permalinks.md: setup/setting-up-navigation.md #permalink
  #       extensions/pymdown.md: reference/admonitions.md
  #       plugins/search.md: setup/setting-up-site-search.md
  #       # plugins/minification.md:
  #       plugins/revision-date.md: setup/adding-a-git-repository.md #revision-date
  #       # plugins/awesome-pages.md:
  #       releases/4.md: upgrading.md #upgrading-from-4x-to-5x
  #       releases/5.md: upgrading.md #upgrading-from-3x-to-4x
  #       releases/changelog.md: changelog.md
  #       sponsorship.md: insiders.md
  - minify:
      minify_html: true

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tigergraph/ecosys
    - icon: fontawesome/brands/discord
      link: https://discord.gg/F2c9b9v
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/c/TigerGraph/videos
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/TigerGraphDB
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/tigergraph/
    - icon: fontawesome/brands/twitch
      link: https://www.twitch.tv/tigergraph

extra_css:
  - stylesheets/extra.css

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: index.md
  - Getting Started:
    - Where to Start?: getting-started.md
    - Graph Fundementals: learn/intro-graph.md
    - Graph + ML: learn/l-ml.md
  
  - Learn:
    - Intro to Graph Fundamentals: learn/intro-graph.md
    - Intro to TigerGraph Products: learn/tg-products.md
    - Intro to GSQL: learn/intro-to-gsql.md
    - Advanced GSQL: learn/advanced-gsql.md
    - Machine Learning: learn/l-ml.md
    - Schema Design: learn/schema-best-practice.md

  - Projects:
    - Active Projects: projects/projects.md
    # - Python: projects/python.md - Coming soon
    # - Visualization: projects/visualization.md - Coming soon
    - Machine Learning: projects/p-ml.md

  - Awesome:
    - TigerGraph: awesome.md

  - Community: 
    - Get Connected: community.md

  
# Google Analytics
google_analytics:
  - !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
  - auto