mkdocs.yml

# Project information
site_name: xBFreE Project
site_url: https://xbfreenergy.github.io
site_author: Mario S. and Mario E. Valdés-Tresanco
site_description: >-
  xBFreE is a project to unify the methods for Binding Free Energy calculations in robust and easy-to-use tools.

# Repository
repo_name: xBFreEnergy.github.io
repo_url: https://github.com/xBFreEnergy/
edit_uri: ""

# Copyright
copyright: Copyright © 2020 - 2023 MS. and ME. Valdés-Tresanco

###########################



#############################
# Configuration
theme:
  name: material
  logo: assets/logo.svg
  custom_dir: docs/overrides

  # 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:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    - navigation.expand
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    # - header.autohide
#    - toc.integrate
    - toc.follow

  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to light mode

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

# Plugins
plugins:
  - tags:
      tags_file: tags.md
  - search
  - git-revision-date-localized:
      type: timeago
      enable_creation_date: true
#  - git-committers:
#      repository: xBFreEnergy/xBFreEnergy.github.io
#      branch: master
  - minify:
      minify_html: true
  - blog:
      post_date_format: medium
      categories_allowed:
        - News
        - Announcements
        - Tutorials
        - Use cases

# Customization
extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/xBFreEnergy/xBFreEnergy.github.io/issues/new" target="_blank" rel="noopener">feedback form</a>.

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/xBFreEnergy
  consent:
    title: Cookie consent
    description: >-
      We use Google Analytics as a third party tracking service. We do not share, sell, rent, or trade this information 
      with third parties for their commercial purposes; and we only use it as this 
      <a href="/help/private_policy/">Privacy Policy</a> describes. This helps us improve documentation and have 
      usage statistics to apply for financing. Thank you.
    actions:
      - accept
# Extensions
markdown_extensions:
  - neoteroi.cards
  - neoteroi.timeline
  - admonition
  - abbr
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - 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:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: Valdes-Tresanco-MS
      repo: xBFreE
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: index.md
  - Project:
      - Project: project/project.md
      - Governance: project/governance.md
      - People: project/people.md
      - Roadmap: project/roadmap.md
      - Contributing: project/contributing.md
  - Apps: apps.md
  - Sponsors: sponsor/index.md
#  - News:
#      - News: news/index.md
  - Help:
    - Help: help/help.md
    - Policy: help/private_policy.md
  - Cite xBFreE: cite_us.md
  - Blog:
      - blog/index.md

extra_css:
  - assets/stylesheets/termynal.css
  - assets/stylesheets/custom.css
  - assets/stylesheets/neoteroi.css
extra_javascript:
  - assets/js/termynal.js
  - assets/js/custom.js
  - assets/js/mathjax.js
  - assets/js/sponsor.js
  - assets/js/news.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js