mkdocs.spec.yml

# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy
# of the License at:
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, SOFTWARE
# DISTRIBUTED UNDER THE LICENSE IS DISTRIBUTED ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
# SEE THE LICENSE FOR THE SPECIFIC LANGUAGE GOVERNING PERMISSIONS AND
# LIMITATIONS UNDER THE LICENSE.

# Project information
site_name: Trust over IP – Specification Template
site_url: https://trustoverip.github.io/mkdocs-material/
site_author: Trust over IP Foundation
site_description: >-
  Trust over IP Foundation template for general documentation
  and technical specification using Material for MkDocs

# Repository information
repo_name: trustoverip/mkdocs-material
repo_url: https://github.com/trustoverip/mkdocs-material

# Content Generator Settings
docs_dir: 'docs'
site_dir: 'html'

# Copyright information
copyright: >-
  Copyright © 2020 Joint Development Foundation Projects, LLC, Trust over
  IP Foundation Series <a href="https://jdfprojects.org/toip/">Terms of Use,
  Privacy Policy and Cookie Policy</a>. The Joint Development Foundation
  Projects, LLC is an affiliate of the Linux Foundation.

# Navigation structure
# nav:
#  - Page 1: page-1.md
#  - Page 2: page-2.md

# Theme configuration
theme:
  name: material
  custom_dir: docs/theme/overrides
  features:
    - navigation.instant
    # - navigation.tabs
  favicon: theme/images/favicon.png
  logo: theme/images/logo.svg
  palette:
    primary: white
    accent: indigo

# Plugin configuration
plugins:
  - search
  - enumerate-headings:
      strict: true
      toc_depth: 3

# Extensions configuration
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: "§"
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: trustoverip
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Additional content
extra:
  title: 'TSS0000: Spec Name'
  lf_url: https://www.linuxfoundation.org/projects
  toip_url: https://trustoverip.org/
  toc_title: Table of contents
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/trustoverip
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/trustoverip
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/trust-over-ip-foundation

# Additional stylesheets
extra_css:
  - theme/stylesheets/main.css
  - theme/stylesheets/spec.css

# Additional JavaScript
extra_javascript:
  - https://unpkg.com/mermaid@8.6.4/dist/mermaid.min.js
  - theme/javascripts/main.js