PdfKmp/mkdocs.yml at master · ConaMobileDev/PdfKmp · 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
# PdfKmp documentation site — Material for MkDocs.
# Local preview:  pip install mkdocs-material && mkdocs serve
# Deployed to GitHub Pages by .github/workflows/docs.yml; the Dokka API
# reference is copied to /api during the same build.
site_name: PdfKmp
site_description: Kotlin Multiplatform PDF generator — Android, iOS, Desktop, and Web from one Compose-style DSL.
site_url: https://conamobiledev.github.io/PdfKmp/
repo_url: https://github.com/conamobiledev/PdfKmp
repo_name: conamobiledev/PdfKmp
edit_uri: edit/master/docs/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Light mode
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - tables
  - attr_list
  # Required for `<div class="grid" markdown>` blocks (index.md screenshots)
  # — without it the Markdown inside raw-HTML containers never renders.
  - md_in_html
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting started:
      - Installation & first PDF: getting-started.md
      - Features:
          - Text & typography: guides/text.md
          - Layout containers: guides/layout.md
          - Tables: guides/tables.md
          - Decorations & effects: guides/decorations.md
          - Images & vectors: guides/images-vectors.md
          - QR, barcodes & charts: guides/graphics.md
          - Links, bookmarks & TOC: guides/navigation.md
          - Pages, headers & watermarks: guides/page-setup.md
          - Forms & security: guides/forms-security.md
          - Fonts, i18n & RTL: guides/i18n.md
      - Companion modules:
          - PDF viewer (Compose): guides/viewer.md
          - Compose Resources: guides/compose-resources.md
          - Markdown to PDF: guides/markdown.md
      - Platforms:
          - Web (Kotlin/Wasm): guides/web.md
          - Platform parity: guides/platform-parity.md
      - Samples: samples.md
  - Internals:
      - Architecture: internals/architecture.md
      - Streaming & memory: streaming-and-memory.md
      - Wasm feasibility: wasm-feasibility.md
  # Absolute URL: the Dokka output is copied into site/api AFTER `mkdocs
  # build`, so a relative link would fail strict-mode validation.
  - API Reference: https://conamobiledev.github.io/PdfKmp/api/