mkdocs.yml

site_name: pyropdf
site_url: https://pyropdf.haya.works/
site_description: PDFs, with Python ergonomics and a Rust core. pyropdf reads, renders, edits, and signs PDF from Python on one versioned object store, so every change can be undone and a failed edit leaves the document as it was.
site_author: Yusuke Hayashi
copyright: Copyright © 2026 Yusuke Hayashi · MIT License
repo_url: https://github.com/yhay81/pyropdf
repo_name: yhay81/pyropdf
edit_uri: edit/main/docs/en/
docs_dir: docs/en
site_dir: site

theme:
  name: material
  variant: modern
  language: en
  custom_dir: docs/overrides
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    logo: material/fire
    repo: fontawesome/brands/github
    alternate: material/translate
  features:
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - search.highlight
    - content.action.copy
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

nav:
  - Home: index.md
  - Guide:
      - Getting started: getting-started.md
      - Concepts: concepts.md
      - Reading content: reading.md
      - Rendering: rendering.md
      - Editing: editing.md
      - Versions and saving: versions.md
      - Limits and errors: limits.md
      - Recipes: recipes.md
  - API reference:
      - api/index.md
      - Documents: api/documents.md
      - Metadata: api/metadata.md
      - Page labels: api/page-labels.md
      - Images: api/images.md
      - Recoloring: api/recoloring.md
      - Layers: api/layers.md
      - Sanitizing: api/sanitizing.md
      - Fonts: api/fonts.md
      - Pages: api/pages.md
      - Drawing: api/drawing.md
      - Text and content: api/text-and-content.md
      - OCR: api/ocr.md
      - Rendering: api/rendering.md
      - Annotations: api/annotations.md
      - Links and destinations: api/links-and-destinations.md
      - Forms and widgets: api/forms-and-widgets.md
      - Outline: api/outline.md
      - Attachments: api/attachments.md
      - History and changes: api/history-and-changes.md
      - Encryption: api/encryption.md
      - Signing: api/signing.md
      - Limits and errors: api/limits-and-errors.md
      - Content operations: api/content-operations.md
      - Objects: api/objects.md
      - Geometry: api/geometry.md
      - Checks and profiles: api/checks-and-profiles.md
      - Typed objects: api/typed-objects.md
  - Project:
      - Choosing pyropdf: choosing.md
      - Status and safety: status.md
      - Specification coverage: specification.md
      - Design: https://github.com/yhay81/pyropdf/blob/main/DESIGN.md
      - Changelog: https://github.com/yhay81/pyropdf/blob/main/CHANGELOG.md

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  # The glossary: its abbreviations show as tooltips on every page.
  - pymdownx.snippets:
      base_path: [docs]
      check_paths: true
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  # Hovering a link to a heading of these pages previews it in place.
  - zensical.extensions.preview:
      configurations:
        - targets:
            include:
              - concepts.md
              - limits.md
              - api/*

plugins:
  - search
  # Serve the Google Fonts from the site itself. Only the fonts: the theme's
  # bundle also names video and lightbox scripts that no page loads, and the
  # plugin would otherwise download them and the ad SDK that they load.
  - privacy:
      assets_include:
        - fonts.googleapis.com/*
        - fonts.gstatic.com/*
  # llms.txt, llms-full.txt, and a Markdown copy of each listed page; the
  # theme's content.action.copy shows "Copy as Markdown" on those pages.
  - llmstxt:
      markdown_description: >-
        The guide explains concepts and tasks with examples that run in the
        project's tests. The API reference is generated from the package's
        docstrings: one page per area, each listing its classes, functions,
        and signatures. The Japanese guide is at
        https://pyropdf.haya.works/ja/llms.txt.
      full_output: llms-full.txt
      sections:
        Guide:
          - getting-started.md
          - concepts.md
          - reading.md
          - rendering.md
          - editing.md
          - versions.md
          - limits.md
          - recipes.md
        API reference:
          - api/*.md
        Project:
          - choosing.md
          - status.md
          - specification.md
  # A social card and Open Graph metadata for every page.
  - social:
      cards_layout_options:
        background_color: "#15120f"
        color: "#f1ebe0"
        font_family: Inter
  - minify:
      minify_html: true
      minify_inline_css: true
      minify_inline_js: true

extra:
  current_language: en
  alternate:
    - name: English
      link: https://pyropdf.haya.works/
      lang: en
    - name: 日本語
      link: https://pyropdf.haya.works/ja/
      lang: ja
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/yhay81/pyropdf
      name: pyropdf on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pyropdf/
      name: pyropdf on PyPI