mkdocs.yml

site_name: IntelOwl Project Documentation
site_description: "A centralized documentation for all the projects under IntelOwl."
site_author: "IntelOwl Project"

copyright: |
  © IntelOwl Project

repo_name: intelowlproject/IntelOwl
repo_url: https://github.com/intelowlproject/IntelOwl

nav:
  - Home: "index.md"
  - IntelOwl:
      - Introduction: "IntelOwl/introduction.md"
      - Installation: "IntelOwl/installation.md"
      - Advanced Configuration: "IntelOwl/advanced_configuration.md"
      - Usage: "IntelOwl/usage.md"
      - Advanced Usage: "IntelOwl/advanced_usage.md"
      - Contribute: "IntelOwl/contribute.md"
      - API docs: "IntelOwl/api_docs.md"
  - GreedyBear:
      - Introduction: "GreedyBear/Introduction.md"
      - Installation: "GreedyBear/Installation.md"
      - Usage: "GreedyBear/Usage.md"
      - Contribute: "GreedyBear/Contribute.md"
      - API docs: "GreedyBear/Api-docs.md"
  - PyIntelOwl:
      - Quickstart: "pyintelowl/index.md"
      - Usage:
          - Modules:
            - IntelOwlClass: "pyintelowl/IntelOwlClass.md"
            - IntelOwlClientException: "pyintelowl/IntelOwlClientException.md"
      - Development:
          - Tests: "pyintelowl/Tests.md"
  - GoIntelOwl:
      - index: "GoIntelOwl/index.md"
  - Guides:
      - Documentation guide: "Guide-documentation.md"
      - Docstrings guide: "Guide-docstrings.md"
      - Submodules: "Submodules.md"
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - monorepo
  - mkdocstrings
  - swagger-ui-tag:
      background: transparent
      text: white
      docExpansion: none
      filter: true
      syntaxHighlightTheme: monokai
      extra_css:
        - assets/css/SwaggerDark.css
      # tryItOutEnabled: true

theme:
  name: material
  logo: static/intel_owl_negative.png
  features:
    - navigation.tabs
    - navigation.path
    - navigation.footer
    - navigation.expand
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - search.highlight
  palette:
    scheme: DARKUI
  font:
    text: IBM Plex Sans
    code: Roboto Mono

# CSS
extra_css:
  - assets/css/custom.css
  - assests/css/SwaggerDark.css

extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-DB4K9LZPDZ
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/intelowlproject
    - icon: fontawesome/brands/slack
      link: https://honeynetpublic.slack.com/archives/C01KVGMAKL6
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/intelowl
    - icon: fontawesome/brands/twitter
      link: https://x.com/intel_owl

markdown_extensions:
  - mdx_truly_sane_lists
  - attr_list
  - md_in_html
  - tables
  - admonition
  - def_list
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.smartsymbols
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.betterem
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: false
      auto_title: false
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.snippets:
      url_download: true