vowl/mkdocs.yml at main · govtech-data-practice/vowl · 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
site_name: ODCS Data Contract Validation Engine
site_description: >-
  vowl is a validation engine for Open Data Contract Standard (ODCS) data contracts.
  Define validation rules once in declarative YAML and get rich, actionable reports
  on data quality across pandas, Polars, PySpark, and 20+ Ibis backends.
site_url: https://govtech-data-practice.github.io/vowl/
repo_url: https://github.com/govtech-data-practice/vowl
repo_name: govtech-data-practice/vowl

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/govtech-data-practice/vowl

theme:
  name: material
  custom_dir: docs/overrides
  logo: img/vowl_logo.png
  favicon: img/vowl_logo.png
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Data Contracts: contracts.md
  - Usage Patterns: usage-patterns.md
  - Architecture: architecture.md
  - Known Issues: known-issues.md
  - Roadmap: roadmap.md

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - meta