mkdocs.yml

site_name: Typeix
site_url: https://typeix.com/
site_author: Igor Ivanovic
site_description: >-
  Fast, unopinionated, minimalist typescript framework for building efficient and scalable applications.
extra_css: [ ]
# Repository
repo_name: typeix
repo_url: https://github.com/typeix/typeix
docs_url: /getting-started
edit_uri: ""


# Copyright
copyright: Copyright © 2016 - 2021 Igor Ivanovic

theme:
  name: material
  custom_dir: theme
  # 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:
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
  palette:
    - scheme: slate
      primary: red
      accent: red

  font:
    text: Roboto
    code: Roboto Mono
  favicon: /assets/favicon.png
  logo: /assets/logo-inverted.png


# Plugins
plugins:
  - search
  - minify:
      minify_html: true
      htmlmin_opts:
        remove_optional_attribute_quotes: false
  - redirects:
      redirect_maps:
        "getting-started.md": "documentation/getting-started.md"
        "documentation/testing.md": "documentation/rest/testing/index.md"
        "documentation/controllers.md": "documentation/rest/controllers.md"
        "documentation/modules.md": "documentation/rest/modules.md"
        "documentation/providers.md": "documentation/rest/providers.md"
        "documentation/interceptors.md": "documentation/rest/interceptors.md"
        "documentation/type-orm.md": "documentation/typeorm/rdbms.md"
        "documentation/type-orm-mongo.md": "documentation/typeorm/mongodb.md"
        "documentation/model-view-controller.md": "documentation/fundamentals/model-view-controller.md"
        "packages/typeix-resty.md": "packages/resty.md"
        "packages/resty/typeix-resty.md": "packages/resty.md"
        "packages/typeix-resty-aws-lambda.md": "packages/resty/aws-lambda-integration.md"
        "packages/typeix-di.md": "packages/di.md"
        "packages/typeix-logger.md": "packages/logger.md"
        "packages/typeix-metadata.md": "packages/metadata.md"
        "packages/typeix-modules.md": "packages/modules.md"
        "packages/typeix-router.md": "packages/router.md"

# Customization
extra:
  analytics:
    provider: google
    property: "G-CRNY5PJKJH" # "G-CRNY5PJKJH"
  twitter: typeixframework
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/typeix
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/typeixframework
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/igorivanoviczg

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - 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.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 - Navigation
nav:
  - Home: index.md
  - Documentation:
      - Getting Started: documentation/getting-started.md
      - Fundamentals:
          - Dependency Injection: documentation/fundamentals/di.md
          - Model View Controller: documentation/fundamentals/model-view-controller.md

      - Resty:
          - Quick Start: documentation/rest/quick-start.md
          - Modules: documentation/rest/modules.md
          - Providers: documentation/rest/providers.md
          - Interceptors: documentation/rest/interceptors.md
          - Controllers: documentation/rest/controllers.md
          - Testing:
              - documentation/rest/testing/index.md
              - Integration: documentation/rest/testing/integration.md
              - Unit: documentation/rest/testing/unit.md

      - TypeORM:
          - Relational Database: documentation/typeorm/rdbms.md
          - Mongodb: documentation/typeorm/mongodb.md

      - GraphQL:
          - Quick Start: documentation/graphql/quick-start.md
          - Types and Fields: documentation/graphql/types-and-fields.md
          - Resolvers: documentation/graphql/resolvers.md
          # - Mutations: documentation/graphql/mutations.md
          # - Directives: documentation/graphql/directives.md
          # - Scalars: documentation/graphql/scalars.md
          # - Subscriptions: documentation/graphql/subscriptions.md
          # - Unions and Enums: documentation/graphql/unions-and-enums.md
      - WebSockets:
          - Quick Start: documentation/websockets/websocket.md
      - Node Packages:
          - "@typeix/resty": packages/resty.md
          - "@typeix/resty-aws-lambda": packages/resty/aws-lambda-integration.md
          - "@typeix/metadata": packages/metadata.md
          - "@typeix/di": packages/di.md
          - "@typeix/modules": packages/modules.md
          - "@typeix/router": packages/router.md
          - "@typeix/logger": packages/logger.md


          # - AWS Lambda Adapter: packages/resty/typeix-resty-aws-lambda.md
  - Benchmarks: benchmarks.md
  - Roadmap: roadmap.md


# Data props

home:
  intro_section:
    h1: Hello, Typeix!
    description: Fast, unopinionated, minimalist framework for building efficient and scalable applications and libraries with typescript or javascript.
  badges:
    - title: EXTENSIBLE
      description: Provides flexibility by allowing use core libraries in own projects.
      icon: material/cogs
    - title: VERSATILE
      description: Adaptable ecosystem for all kinds of server-side applications or custom libraries.
      icon: material/auto-fix
    - title: LIGHTWEIGHT
      description: "@typeix/resty is a minimal and flexible Node.js web application framework that provides a robust set of features."
      icon: material/progress-wrench
  live_preview:
    h1: Live preview
    description: See how your application may potentially look.