docs/mkdocs.yml at main · fullbleed-engine/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
site_name: Fullbleed
site_url: https://docs.fullbleed.dev/
site_description: Generate PDFs from HTML and CSS in Python, Rust, Node.js, C#, and browsers. Start with a runnable example and a Rust print engine. 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
  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
    - Python installation: getting-started/installation.md
    - Python notebook: getting-started/notebook.md
    - Use WooCommerce: guides/woocommerce.md
    - Python fonts and previews: getting-started/first-pdf.md
    - Examples and downloads: examples.md
  - Build a document:
    - Invoices from data: guides/invoices.md
    - Markdown to PDF: guides/markdown-pdf.md
    - Chinese text and fonts: guides/chinese-pdf.md
    - pandas DataFrame to PDF: guides/pandas-to-pdf.md
    - Rebuild as you edit: guides/render-watch.md
    - Check PDFs in CI: guides/pdf-regression-ci.md
    - FastAPI, Flask, and Django: guides/web-frameworks.md
    - Browser PDF generation: guides/browser-pdf.md
    - React PDF previews: guides/react-pdf.md
    - Next.js PDF downloads: guides/nextjs-pdf.md
    - ASP.NET Core PDF downloads: guides/aspnet-pdf.md
    - Variable-data documents: guides/bank-statements.md
    - Tagged PDF and accessibility: accessibility/overview.md
    - Print output and PDF/VT: guides/print-output.md
    - Coding agents and MCP: guides/ai-agents.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 coverage: css-coverage.md
    - Engine architecture: engine/overview.md
  - Evaluate:
    - Choose a PDF library: guides/comparison.md
    - Three-renderer comparison: guides/renderer-comparison.md
    - PDF file size: guides/pdf-size.md
    - Performance evidence: guides/performance.md
    - FAQ: faq.md
  - Contribute and support: support.md
  - Commerce:
    - Shopify preview: commerce/shopify.md
    - Merchant agreement: commerce/agreements/2026-10-04.md
    - Privacy: commerce/privacy.md