mkdocs.yml

site_name: KeyBERT
repo_url: https://github.com/MaartenGr/keyBERT
site_url: https://maartengr.github.io/keyBERT/
site_description: Leveraging BERT to extract important keywords
site_author: Maarten P. Grootendorst
use_directory_urls: false
extra_css:
  - stylesheets/extra.css


nav:
  - Home: index.md
  - Guides:
      - Quickstart: guides/quickstart.md
      - Embedding Models: guides/embeddings.md
      - CountVectorizer: guides/countvectorizer.md
      - KeyLLM: guides/keyllm.md
      - LLMs: guides/llms.md
  - API:
      - KeyBERT: api/keybert.md
      - MMR: api/mmr.md
      - MaxSum: api/maxsum.md
      - KeyLLM: api/keyllm.md
      - LLM:
        - OpenAI: api/openai.md
        - Cohere: api/cohere.md
        - LangChain: api/langchain.md
        - TextGeneration: api/textgeneration.md
        - LiteLLM: api/litellm.md
  - FAQ: faq.md
  - Changelog: changelog.md

plugins:
  - mkdocstrings:
      watch:
        - keybert
  - search
copyright: Copyright &copy; 2024 Maintained by <a href="https://github.com/MaartenGr">Maarten Grootendorst</a>.

theme:
  custom_dir: images/
  name: material
  icon:
    logo: material/library
  font:
    text: Ubuntu
    code: Ubuntu Mono
  favicon: icon.png
  logo: icon.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.instant
    - navigation.top
    - navigation.tracking
    - toc.follow
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: black
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    toggle:
      icon: material/weather-night
      name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets
  - toc:
      permalink: true