mkdocs.yml

# Essentials & navigation
# ------------------------------------------------
# https://www.mkdocs.org
# https://squidfunk.github.io/mkdocs-material

site_name: OpenAD
docs_dir: main
repo_url: https://github.com/acceleratedscience/openad-toolkit
nav:
    # - Style Reference: style-reference.md
    - Home: index.md
    - Documentation:
          - docs/index.md
          - Installation: docs/installation.md
          - Getting Started: docs/getting-started.md
          - Base Concepts: docs/base-concepts.md
          - Model Service:
                - docs/model-service/index.md
                - Available Models: docs/model-service/available-models.md
                - Deploying Models: docs/model-service/deploying-models.md
                - Using Models: docs/model-service/using-models.md
                - Wrapping New Models: docs/model-service/wrapping.md
                - IBM Hosted: docs/model-service/ibm-hosted.md
          - Commands: docs/commands.md
          - GUI: docs/gui.md
          - API: docs/api.md
          - Plugins: docs/plugins.md
          - Plugin Development:
                - docs/plugin-development/index.md
                - Knowledge Base: docs/plugin-development/knowledge-base.md
                - PyParsing 101: docs/plugin-development/pyparsing-101.md
          - Tell Me: docs/tell-me.md
          - Developers: docs/developers.md
          - Troubleshooting: docs/troubleshooting.md
    - Tutorials:
          - blog/index.md
    - About: about.md

# Theme configuration
# ------------------------------------------------
# https://squidfunk.github.io/mkdocs-material/setup

theme:
    name: material
    palette:
        # Palette toggle for automatic mode
        - media: "(prefers-color-scheme)"
          toggle:
              icon: carbon/icn-dark-mode-auto
              name: Dark mode auto

        # Palette toggle for light mode
        - media: "(prefers-color-scheme: light)"
          scheme: carbon
          toggle:
              icon: carbon/icn-dark-mode-off
              name: Dark mode on

        # Palette toggle for dark mode
        - media: "(prefers-color-scheme: dark)"
          scheme: carbon-dark
          toggle:
              icon: carbon/icn-dark-mode-on
              name: Dark mode off

    # Replace icons
    logo: _assets/icn-logo.svg
    # favicon: _assets/icn-logo.svg
    favicon: _assets/icn-bee.svg
    icon:
        menu: carbon/icn-hamburger
        alternate: carbon/icn-language
        search: carbon/icn-search
        share: carbon/icn-share
        close: carbon/icn-close
        top: carbon/icn-arrow-up
        edit: carbon/icn-edit
        view: carbon/icn-file-html
        repo: carbon/icn-github
        previous: carbon/icn-arrow-left
        next: carbon/icn-arrow-right
        # tag: carbon/icn-star - https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons-and-identifiers
        admonition:
            note: carbon/icn-megaphone
            abstract: carbon/icn-result
            info: carbon/icn-info
            tip: carbon/icn-fire
            success: carbon/icn-yes
            question: carbon/icn-question
            warning: carbon/icn-warning
            failure: carbon/icn-no
            danger: carbon/icn-caution
            bug: carbon/icn-bug
            example: carbon/icn-person
            quote: carbon/icn-quote

    features:
        - navigation.tabs # Tabs for main sections
        - navigation.indexes # Overview pages for sections
        # - navigation.instant # Navigate without reloading the page
        # - navigation.instant.progress # Progress bar
        - navigation.top # Back to top link
        # - navigation.path # Breadcrumbs - sponsors only
        - toc.follow # Auto-scroll the TOC sidebar
        - content.code.copy
        - content.code.annotate
        # - content.code.select # Auto-select - sponsors only
        # - content.tooltips # HTML tooltips, rather annoying since you can't disable them on headers etc.

    # Overrides let us specify different HTML files
    # for certain pages, used to customize the landing
    # as well as custom icons
    custom_dir: main/_overrides

extra_css:
    - _css/carbon-color-overrides.css
    - _css/carbon-1-colors.css
    - _css/carbon-2-vars.css
    - _css/carbon-3-base.css
    - _css/carbon-nav-header.css
    - _css/carbon-nav-side.css
    - _css/carbon-search.css
    - _css/carbon-layout.css
    - _css/carbon-blog.css
    - _css/carbon-blog-meta.css
    - _css/carbon-admonitions.css
    - _css/carbon-commands.css
    - _css/main.css

plugins:
    - search

    # Enable blog
    - blog:
          blog_dir: blog
          post_date_format: medium
          post_excerpt: required

    # Created nice cars for social media
    # Can't get iage processing to work, abandoned for now
    # https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/
    # - social

# https://www.mkdocs.org/user-guide/configuration/#validation-of-absolute-links
validation:
    links:
        absolute_links: relative_to_docs

# See file for details
hooks:
    - custom_hooks.py

# Enable page status
extra:
    status:
        new: new content

# Extensions
# ------------------------------------------------

markdown_extensions:
    # Turns every header into a link
    - toc:
          permalink: §

    # Allow setting attributes on elements
    # eg. [link](url){data-preview}
    - attr_list

    # Lets us wrap markdown in HTML tags
    - md_in_html

    # Allows for image captions
    - pymdownx.blocks.caption

    # Icons
    # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#configuration
    - pymdownx.emoji:
          emoji_index: !!python/name:material.extensions.emoji.twemoji
          emoji_generator: !!python/name:material.extensions.emoji.to_svg
          options:
              custom_icons:
                  - main/_overrides/.icons

    # Code formatting
    - pymdownx.highlight:
          linenums: false # May want to enable later, but requires additional styling
          anchor_linenums: true
          line_spans: __span
          pygments_lang_class: true
          auto_title: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences

    # Warning / note etc.
    - admonition

    # Instant preview of links
    # Nice to have feature, but only available to sponsors
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=data+preview#instant-previews
    # - material.extensions.preview:
    #     configurations:
    #       - targets:
    #           include:
    #             - changelog/index.md