mkdocs.yml

# Site information
site_name: Outlines
site_author: The Outlines developers
site_description: >-
  Structured text generation with LLMs


# Repository
repo_name: dottxt-ai/outlines
repo_url: https://github.com/dottxt-ai/outlines

# Copyright
copyright: Copyright © 2023- The Outlines Developers

# Configuration
theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - scheme: default
      primary: white
  logo: assets/images/logo-square.svg
  favicon: assets/images/logo-simple.png
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - navigation.expand
    - navigation.tabs
    - navigation.sections
    - header.autohide
    - announce.dismiss
  font:
    text: Inter
    code: Source Code Pro

# Additional configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dottxt-ai
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/remilouf
  generator: false
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  version:
    provider: mike
    default: latest
    alias: true

# Extensions
markdown_extensions:
  - admonition
  - def_list
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      noclasses: True
      pygments_style: nord
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg


extra_css:
  - stylesheets/extra.css

plugins:
  - blog
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_submodules: true
  - search
  - section-index
  - social:
      cards_layout_options:
        color: #173a58
  - git-committers:
      repository: dottxt-ai/outlines
      branch: main
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

nav:
  - Home: index.md
  - Getting Started:
      - Welcome to Outlines: welcome.md
      - Installation: installation.md
      - Quickstart: quickstart.md
      - Licence: licence.md
  - Cookbook:
      - cookbook/index.md
      - Classification: cookbook/classification.md
      - Named Entity Extraction: cookbook/extraction.md
      - Generate synthetic data: cookbook/dating_profiles.md
      - Summarize a document: cookbook/chain_of_density.md
      - Playing chess: cookbook/models_playing_chess.md
      - Perspective-taking prompting: cookbook/simtom.md
      - Question-answering with citations: cookbook/qa-with-citations.md
      - Knowledge Graph Extraction: cookbook/knowledge_graph_extraction.md
      - Structured Generation Workflow: cookbook/structured_generation_workflow.md
      - Chain of Thought (CoT): cookbook/chain_of_thought.md
      - ReAct Agent: cookbook/react_agent.md
      - Vision-Language Models: cookbook/atomic_caption.md
      - Structured Generation from PDFs: cookbook/read-pdfs.md
      - Earnings reports to CSV: cookbook/earnings-reports.md
      - Digitizing receipts with vision models: cookbook/receipt-digitization.md
      - Run on the cloud:
          - BentoML: cookbook/deploy-using-bentoml.md
          - Cerebrium: cookbook/deploy-using-cerebrium.md
          - Modal: cookbook/deploy-using-modal.md
  - Docs:
    - reference/index.md
    - Generation:
        - Overview: reference/generation/generation.md
        - Text: reference/text.md
        - Samplers: reference/samplers.md
        - Structured generation:
            - How does it work?: reference/generation/structured_generation_explanation.md
            - Classification: reference/generation/choices.md
            - Regex: reference/generation/regex.md
            - Type constraints: reference/generation/format.md
            - JSON (function calling): reference/generation/json.md
            - Grammar: reference/generation/cfg.md
            - Creating Grammars: reference/generation/creating_grammars.md
            - Custom FSM operations: reference/generation/custom_fsm_ops.md
    - Utilities:
        - Serve with vLLM: reference/serve/vllm.md
        - Serve with LM Studio: reference/serve/lmstudio.md
        - Custom types: reference/generation/types.md
        - Prompt templating: reference/prompting.md
        - Outlines functions: reference/functions.md
    - Models:
        - Overview: reference/models/models.md
        - Open source:
          - Transformers: reference/models/transformers.md
          - Transformers Vision: reference/models/transformers_vision.md
          - Llama.cpp: reference/models/llamacpp.md
          - vLLM: reference/models/vllm.md
          - TGI: reference/models/tgi.md
          - ExllamaV2: reference/models/exllamav2.md
          - MLX: reference/models/mlxlm.md
          - Mamba: reference/models/transformers.md
        - API:
            - OpenAI: reference/models/openai.md
  - API Reference:
    - api/index.md
    - api/models.md
    - api/prompts.md
    - api/json_schema.md
    - api/guide.md
    - api/parsing.md
    - api/regex.md
    - api/samplers.md
  - Community:
    - community/index.md
    - Feedback 🫶: community/feedback.md
    - Chat with us ☕: https://discord.com/invite/R9DSu34mGd
    - How to contribute 🏗️: community/contribute.md
    - Your projects 👏: community/examples.md
    - Versioning Guide 📌: community/versioning.md
  - Blog: blog/index.md