JS_Barcode_Universal/mkdocs.yml at main · Sythos/JS_Barcode_Universal · 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
site_name: Sythos Barcode Universal
site_description: JavaScript and TypeScript barcode generation and reading SDK documentation
site_url: https://sythos.github.io/JS_Barcode_Universal/
repo_name: Sythos/JS_Barcode_Universal
repo_url: https://github.com/Sythos/JS_Barcode_Universal
edit_uri: edit/main/docs/
copyright: Copyright © Sythos

extra:
  google_site_verification: "S48wpepgNs-76l-hkn9hVyxCQA420iultO8u7PI4GR8"

docs_dir: docs

# Keep unfinished milestone pages out of the published site until their content
# is reviewed and promoted into the public documentation set.
exclude_docs: |
  DOCS_ARCHITECTURE.md

theme:
  name: material
  custom_dir: overrides
  language: en
  logo: assets/branding/qr-sythos-net.png
  favicon: assets/branding/qr-sythos-net.png
  features:
    - navigation.instant
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search:
      lang:
        - en

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting started:
      - Installation: installation.md
      - First steps: getting-started.md
  - API reference:
      - Overview: api/overview.md
      - Encoding: api/encoding.md
      - Decoding: api/decoding.md
      - Rendering: api/rendering.md
      - TypeScript: api/typescript.md
      - Subpath exports: api/subpath-exports.md
  - Formats:
      - Overview: formats/overview.md
      - Linear 1D: formats/oned.md
      - Postal 4-state: formats/postal.md
      - QR family: formats/qr-family.md
      - Data Matrix ECC 200: formats/datamatrix.md
      - Aztec family: formats/aztec.md
      - PDF417 family: formats/pdf417-family.md
      - GS1, EAN and UPC: formats/gs1-and-ean.md
      - GS1 DataBar Expanded: formats/databar-expanded.md
      - MaxiCode: formats/maxicode.md
      - Codablock-F: formats/codablockf.md
      - Code 16K: formats/code16k.md
      - DotCode: formats/dotcode.md
      - Han Xin Code: formats/hanxin.md
      - GS1 DataBar Composite: formats/gs1-composite.md
      - Sythos Canvas QR profile: formats/frameqr-profile.md
      - Excluded and out-of-scope formats: formats/excluded-formats.md
  - Platform guides:
      - Browser: guides/browser.md
      - Node.js: guides/node.md
      - Web Workers: guides/web-workers.md
      - Camera reading: guides/camera-reading.md
      - Image pipeline: guides/image-pipeline.md
      - Performance: guides/performance.md
      - Security: guides/security.md
      - Licensing and provenance: guides/licensing.md
      - Release verification: release-verification.md
  - Recipes:
      - Create a barcode: examples/create-barcode.md
      - Read a barcode: examples/read-barcode.md
      - Camera loop: examples/camera-loop.md
      - TypeScript project: examples/typescript-project.md
  - FAQ: faq.md
  - Troubleshooting: troubleshooting.md