mkdocs_preview_template.yml

site_name: DHIS2 Documentation
site_description: Official documentation of the DHIS2 platform
site_author: DHIS2 Documentation Team
# site_url sets the canonical url - we want this to point to the latest version
site_url: 'https://docs.dhis2.org/en/'
copyright: 'Copyright © 2008-2021 DHIS2 Team'
# edit_uri: ''
repo_url: https://github.com/dhis2/dhis2-docs
repo_name: 'dhis2-docs on GitHub'
use_directory_urls: false
docs_dir: <path-to-preview-doc>

extra:
  dhis2_languages:
    en: 'English'
    fr: 'Français'
    es_419: 'Español (latinoamerica)'
    pt: 'Português'
    cs: 'čeština'
    zh: '中文'
  social:
    - icon: fontawesome/brands/github
      link: https://www.github.com/dhis2
      name: DHIS2 source code on GitHub
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/u/dhis2
      name: DHIS2 on Docker
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/dhis_2
      name: DHIS2 on Twitter
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/dhis2
      name: DHIS2 on Facebook
    - icon: fontawesome/brands/discourse
      link: https://community.dhis2.org
      name: DHIS2 Community
  analytics:
    provider: google
    property: UA-157707339-2

theme:
  name: material
  logo: 'resources/images/logo.svg'
  favicon: 'resources/images/favicon.ico'
  features:
    - navigation.menutabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.instant
    - toc.integration
    - content.action.edit
    - content.code.copy
    - search.suggest
    - search.highlight
    - search.share
  alternates:
    alt_marker: 'alt__'
  custom_dir: 'theme'
  palette:
    - scheme: default
      primary: 'black'
      accent: 'blue'
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: 'black'
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  language: 'en'
  font: false
  filter:
    versions:
      - master
      - 2.36
      - 2.35
      - 2.34
    categories:
      - Use
      - Implement
      - Develop
      - Manage
      - Metadata
      - Tutorials
      - Stories
  filter_boost:
    - '2.39'

# our css
extra_css:
  - resources/css/mkdocs_dhis2.css

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - resources/javascript/config.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search:
      separator: '[\s]+'
  - mkdocs_video:
      css_style:
        position: "relative"
        width: "600px"
        height: "400px"
  - edit_url
  # - dhis2_docs
  - minify:
      minify_html: true
  - offline


markdown_extensions:
  - codehilite:
      guess_lang: false
  - markdown_captions
  - toc:
      permalink: true
      toc_depth: 3
  - d_cardbox
  - d_card
  - attr_list
  - def_list
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.emoji:
      emoji_index: !!python/name:pymdownx.emoji.gemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_png
  - pymdownx.inlinehilite:
      custom_inline:
        - name: math
          class: arithmatex
          format: !!python/name:pymdownx.arithmatex.inline_mathjax_format
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols:
      copyright: false
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

# output when building
site_dir: ./target/preview/

nav:
    - Preview:
        <filename-without-extension>: <filename-with-extension>