mkdocs.yml

site_name: Fullbleed
site_url: https://docs.fullbleed.dev/
site_description: Generate PDFs from HTML/CSS in Python, Rust, JavaScript, and C#. Build invoices, reports, and print documents with bundled fonts and local output. MIT licensed.
site_author: Fullbleed Engine
repo_url: https://github.com/fullbleed-engine/fullbleed-official
repo_name: Fullbleed on GitHub
edit_uri: ''
theme:
  name: material
  favicon: assets/brand/fullbleed-print-mark.svg
  custom_dir: overrides
  font: false
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
extra_css:
  - stylesheets/extra.css
plugins:
  - search
  - redirects:
      redirect_maps:
        engine/headers-footers.md: engine/pdf-engine.md
        engine/paginated-context.md: engine/pdf-engine.md
        engine/page-margins.md: engine/pdf-engine.md
        engine/watermarks.md: engine/pdf-engine.md
        engine/batch.md: guides/bank-statements.md
        cli/scaffolding.md: getting-started/quickstart.md
        cli/diagnostics.md: cli/commands.md
        ui/primitives.md: ui/overview.md
        ui/accessibility.md: ui/overview.md
        ui/style.md: ui/overview.md
        accessibility/engine.md: ui/overview.md
        accessibility/evidence-bundles.md: accessibility/overview.md
        accessibility/coverage.md: accessibility/overview.md
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
extra:
  generator: false
copyright: 'Fullbleed Engine · MIT licensed · <a href="https://docs.fullbleed.dev/support/">Support Fullbleed</a>'
nav:
  - Home: index.md
  - Get started:
    - Try in your browser: playground.md
    - Python quickstart: getting-started/quickstart.md
    - Node.js quickstart: getting-started/node.md
    - Rust quickstart: getting-started/rust.md
    - C# and .NET quickstart: getting-started/dotnet.md
    - Examples and downloads: examples.md
    - Python setup and notebooks:
      - Python installation: getting-started/installation.md
      - Fonts and previews: getting-started/first-pdf.md
      - Invoice notebook: getting-started/notebook.md
  - Build a document:
    - Invoices from data: guides/invoices.md
    - Existing PDF templates: guides/pdf-template.md
    - Reports and data:
      - Numbered reports: guides/numbered-reports.md
      - Markdown to PDF: guides/markdown-pdf.md
      - pandas DataFrame to PDF: guides/pandas-to-pdf.md
      - Matplotlib chart reports: guides/matplotlib-pdf.md
      - Variable-data documents: guides/bank-statements.md
    - Complete HTML documents: guides/complete-html.md
    - Author with components:
      - Python components: guides/python-components.md
      - JavaScript components and JSX: guides/javascript-components.md
      - C# components and styles: guides/csharp-components.md
      - pandas with Python components: guides/pandas-components.md
      - One design, two authoring paths: guides/showcase-authoring.md
      - Python 2.6 alpha:
        - Release status: guides/component-status.md
        - Component API preview: guides/component-preview-12.md
        - Static Bootstrap helpers: guides/bootstrap-components-preview.md
        - Component notebook: getting-started/component-notebook.md
        - Styling notebook: getting-started/component-styling.md
        - Page-band notebook: getting-started/page-band-notebook.md
        - Accessible component showcase: guides/accessible-showcase.md
        - Earlier design preview: guides/component-design-preview.md
    - Fonts and languages:
      - Chinese text and fonts: guides/chinese-pdf.md
      - Arabic and English PDFs: guides/arabic-pdf.md
    - Tagged PDFs and accessibility:
      - Tagged PDF workflow: accessibility/overview.md
      - Tagged PDFs in C#: guides/csharp-tagged-pdf.md
    - Clickable PDF links (alpha): guides/pdf-links.md
    - Print output and PDF/VT: guides/print-output.md
  - Integrate and automate:
    - Python apps:
      - FastAPI, Flask, and Django: guides/web-frameworks.md
      - Streamlit PDF downloads: guides/streamlit-pdf.md
      - Python in Docker: guides/python-docker.md
      - Python in AWS Lambda: guides/aws-lambda-pdf.md
    - JavaScript apps:
      - Browser PDF generation: guides/browser-pdf.md
      - React PDF previews: guides/react-pdf.md
      - Vue PDF previews: guides/vue-pdf.md
      - Next.js PDF downloads: guides/nextjs-pdf.md
      - Queue Node PDF jobs: guides/node-render-queue.md
      - PDFs in Cloudflare Workers: guides/cloudflare-pdf.md
    - Rust and Axum PDF downloads: guides/axum-pdf.md
    - ASP.NET Core PDF downloads: guides/aspnet-pdf.md
    - Laravel Blade and queues: guides/laravel-pdf.md
    - Workflow automation:
      - n8n invoice workflows: guides/n8n-pdf.md
      - Coding agents and MCP: guides/ai-agents.md
    - Development workflow:
      - Rebuild as you edit: guides/render-watch.md
      - Check PDFs in CI: guides/pdf-regression-ci.md
    - Commerce:
      - Use WooCommerce: guides/woocommerce.md
      - Shopify preview: commerce/shopify.md
      - Merchant agreement: commerce/agreements/2026-10-04.md
      - Privacy: commerce/privacy.md
  - Reference:
    - Python API: engine/pdf-engine.md
    - CLI: cli/commands.md
    - Fonts and assets: engine/assets.md
    - Font face selection: engine/font-registration.md
    - Python components: ui/overview.md
    - PDF template composition: engine/template-composition.md
    - CSS support: css-coverage.md
    - Engine architecture: engine/overview.md
  - Evaluate:
    - Compare Python PDF libraries: guides/comparison.md
    - Three-renderer comparison: guides/renderer-comparison.md
    - Browse CSS results: guides/css-explorer.md
    - CSS corpus evidence: guides/css-corpus.md
    - PDF file size: guides/pdf-size.md
    - Performance evidence: guides/performance.md
    - FAQ: faq.md
  - Support Fullbleed: support.md