mkdocs.yml

# See https://squidfunk.github.io/mkdocs-material/
# https://www.mkdocs.org/user-guide/deploying-your-docs/#organization-and-user-pages
# https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins

site_name: "HGVS Nomenclature"
site_url: https://hgvs-nomenclature.org
repo_url: https://github.com/HGVSNomenclature/hgvs-nomenclature
# strict: true
copyright: <a href="https://creativecommons.org/publicdomain/zero/1.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC0 1.0 Universal</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/HGVSnomenclature/hgvs-nomenclature/graphs/contributors">HGVS Nomenclature Contributors</a>

plugins:
  - awesome-pages
  - markdown-exec
  - search
  - mkdocs-simple-hooks:
      hooks:
        on_pre_build: "simple_hooks.generate_release_notes:main"
  - macros
  - table-reader

hooks:
  - hooks.py

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - markdown_captions
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.superfences
  - toc:
      permalink: "#"
      toc_depth: 1

extra:
  analytics:
    provider: google
    property: G-EJ2MT1N34E
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HGVSNomenclature/hgvs-nomenclature

extra_css:
  - stylesheets/extra.css

# enabling strict above (or mkdocs build --strict) causes warnings to become fatal
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

theme:
  name: material
  custom_dir: overrides

  features:
    - announce.dismiss
    - navigation.indexes # enable section-level pages
    - navigation.instant # single-page app
    - navigation.tracking # add section fragment to URL
    - search.highlight # highlight search terms in pages
    - toc.follow # toc follows scroll
    - toc.integrate # integrate page headings into toc
  # Tabs are nice, but apparently remove the side nav
  # - navigation.tabs
  # - navigation.tabs.sticky

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: hvnc
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  font:
    text: Lato
    code: Roboto Mono
  logo: images/hgvs-logo.png
  favicon: images/hgvs-logo.png

exclude_docs: |
  /call-for-members.md

watch:
  - bin
  - lib
  - overrides
  - overrides/partials
  - hooks.py