mkdocs.yml

# Project information
site_name: Awesome TM1 Planning Analytics
site_url: https://awesome-tm1-planning-analytics.netlify.app/
site_author: "Kevin Lou"
site_description: >-
  Collection and Sharings of best practice, toolkits
  about IBM Planning Analytics (formerly Cognos TM1)

# Repository
repo_name: kevin7lou/awesome-tm1-planning-analytics
repo_url: https://github.com/kevin7lou/awesome-tm1-planning-analytics
# edit_uri: "https://github.com/peaceiris/mkdocs-material-boilerplate/edit/main/docs_sample"

# Copyright
copyright: Copyright © 2022 - 2024 Kevin Lou


# Configuration
docs_dir: "docs"
theme:
  name: "material"
  language: "en"
#   custom_dir: material/overrides
#   features:
#     - announce.dismiss
#     - content.action.edit
#     - content.action.view
#     - content.code.annotate
#     - content.code.copy
#     # - content.code.select
#     # - content.footnote.tooltips
#     # - content.tabs.link
#     - content.tooltips
#     # - header.autohide
#     # - navigation.expand
#     - navigation.footer
#     - navigation.indexes
#     # - navigation.instant
#     # - navigation.instant.prefetch
#     # - navigation.instant.progress
#     # - navigation.prune
#     - navigation.sections
#     - navigation.tabs
#     # - navigation.tabs.sticky
#     - navigation.top
#     - navigation.tracking
#     - search.highlight
#     - search.share
#     - search.suggest
#     - toc.follow
#     # - toc.integrate
  palette:
  # Palette toggle for automatic mode
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  # Palette toggle for light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: indigo
    accent: blue
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  # Palette toggle for dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: indigo
    accent: blue
    toggle:
      icon: material/brightness-4
      name: Switch to system preference
  # shortcuts:
  #   help: 191 # ?
  #   next: 78 # n
  #   previous: 80 # p
  #   search: 83 # s
  # palette:
  #   primary: "blue"
  #   accent: "blue"
  # features:
  #   - tabs
  #font:
  #text: 'Ubuntu'
  #code: 'Ubuntu Mono'
  #icon:
  #logo: 'images/logo.svg'
  #favicon: 'assets/images/favicon.ico'

#   font:
#     text: Roboto
#     code: Roboto Mono
#   favicon: assets/favicon.png
#   icon:
#     logo: logo

# Plugins
plugins:
  # - blog
  - search:
      separator: '[\s\-\.]+'
      # '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  # - minify:
  #     minify_html: true

# # Hooks
# hooks:
#   - material/overrides/hooks/shortcodes.py
#   - material/overrides/hooks/translations.py

# # Additional configuration
# extra:
#   status:
#     new: Recently added
#     deprecated: Deprecated
#   analytics:
#     provider: google
#     property: !ENV GOOGLE_ANALYTICS_KEY
#   social:
#     - icon: fontawesome/brands/github
#       link: https://github.com/squidfunk
#     - icon: fontawesome/brands/docker
#       link: https://hub.docker.com/r/squidfunk/mkdocs-material/
#     - icon: fontawesome/brands/python
#       link: https://pypi.org/project/mkdocs-material/
#     - icon: fontawesome/brands/mastodon
#       link: https://fosstodon.org/@squidfunk
#     - icon: fontawesome/brands/twitter
#       link: https://twitter.com/squidfunk

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - codehilite
  - toc:
      permalink: true
      # separator: "_"
  # # - mdx_math:
  # #     enable_dollar_delimiter: true
  # - pymdownx.arithmatex:
  #     generic: true
  # - pymdownx.betterem:
  #     smart_enable: all
  # - pymdownx.caret
  # - pymdownx.details
  # # - pymdownx.emoji:
  # #     emoji_generator: !!python/name:material.extensions.emoji.to_svg
  # #     emoji_index: !!python/name:material.extensions.emoji.twemoji
  # - pymdownx.highlight:
  #     anchor_linenums: true
  #     line_spans: __span
  #     pygments_lang_class: true
  # - pymdownx.inlinehilite
  # - pymdownx.keys
  # - pymdownx.magiclink:
  #     normalize_issue_symbols: true
  #     repo_url_shorthand: true
  #     user: squidfunk
  #     repo: mkdocs-material
  # - pymdownx.mark
  # - pymdownx.smartsymbols
  # - pymdownx.snippets:
  #     auto_append:
  #       - includes/mkdocs.md
  # - pymdownx.superfences:
  #     custom_fences:
  #       - name: mermaid
  #         class: mermaid
  #         format: !!python/name:pymdownx.superfences.fence_code_format
  # # - pymdownx.tabbed:
  # #     alternate_style: true
  # #     combine_header_slug: true
  # #     slugify: !!python/object/apply:pymdownx.slugs.slugify
  # #       kwds:
  # #         case: lower
  # - pymdownx.tasklist:
  #     custom_checkbox: true
  # - pymdownx.tilde

# # Customization
# extra_javascript:
#   - "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js?config=TeX-MML-AM_CHTML"
# extra_css:
#   - "assets/css/custom.css"
# extra:
#   manifest: "manifest.json"
#   social:
#     - icon: "fontawesome/brands/github-alt"
#       link: "https://github.com/peaceiris"
#     - icon: "fontawesome/brands/twitter"
#       link: "https://twitter.com/piris314en"

# Page tree
nav:
  - Home: index.md
  - Performanece: performance.md
  # - "Home": "index.md"
  # - "Material for MkDocs": "material-for-mkdocs.md"
  # - "Getting started":
  #     - "Download boilerplate": "getting-started/download-boilerplate.md"
  #     - "pipenv": "getting-started/pipenv.md"
  #     - "invoke": "getting-started/invoke.md"
  #     - "Docker": "getting-started/docker.md"
  #     - "pip": "getting-started/pip.md"
  # - "Hosting and Deployment":
  #     - "Combinations": "hosting-and-deployment/combinations.md"
  #     - "Netlify": "hosting-and-deployment/netlify.md"
  #     - "GitHub Pages": "hosting-and-deployment/github-pages.md"
  #     - "GitLab Pages": "hosting-and-deployment/gitlab-pages.md"
  #     - "AWS Amplify Console": "hosting-and-deployment/aws-amplify-console.md"
  # - "Extensions":
  #     - "MathJax": "extensions/mathjax.md"
  #     - "Code Hilite": "extensions/code-hilite.md"
  #     - "Footnote": "extensions/footnote.md"
  # - "License": "license.md"