mkdocs_offline.yml

# Format documented here
# http://www.mkdocs.org/user-guide/configuration/
# https://squidfunk.github.io/mkdocs-material/getting-started/
# See this document for list of plugins to disable for offline (local) documentation
# https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/

edit_uri: ""
site_url: http://utPLSQL.org/
site_name: utPLSQL-framework
site_description: utPLSQL Ultimate Testing Framework for Oracle PL/SQL & SQL
copyright: Copyright © 2016 - 2022 utPLSQL Team
#repo_url: https://github.com/utPLSQL/utPLSQL # disable for offline docs
extra_css:
  - stylesheets/extra.css
theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
  logo: assets/icon-transparent.png
  favicon: assets/favicon.png
  features:
#    - navigation.instant  # disable for offline docs
#    - navigation.indexes
    - navigation.tabs
    - navigation.tracking
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
extra:
#  homepage: http://jgebal.github.io/
#  homepage: http://utPLSQL.org/
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/utPLSQL
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/utplsql/shared_invite/zt-xwm68udy-4cF_3PNEyczYEbWr38W5ww
    - icon: fontawesome/brands/github
      link: https://github.com/utPLSQL
    - icon: fontawesome/solid/envelope
      link: mailto:utPLSQL@utPLSQL.org
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
#  version:            # disable for offline docs
#    provider: mike    # disable for offline docs
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - toc:
      permalink: true
use_directory_urls: false
strict: true

plugins:
#  - search                        # disable for offline docs
  - mike
#  - git-revision-date-localized: # disable for offline docs
#      enable_creation_date: true # disable for offline docs
#      type: datetime             # disable for offline docs

nav:
  - User Guide:
       - index.md
       - Installation: userguide/install.md
       - Getting Started: userguide/getting-started.md
       - Annotations: userguide/annotations.md
       - Expectations: userguide/expectations.md
       - Advanced data comparison: userguide/advanced_data_comparison.md
       - Running unit tests: userguide/running-unit-tests.md
       - Querying for test suites: userguide/querying_suites.md
       - Testing best practices: userguide/best-practices.md
       - Upgrade utPLSQL: userguide/upgrade.md
  - Reporting:
       - Using reporters: userguide/reporters.md
       - Code coverage: userguide/coverage.md
       - Error handling and reporting: userguide/exception-reporting.md
  - About:
       - Project Details: about/project-details.md
       - License: about/license.md
       - Support: about/support.md
       - Authors: about/authors.md