recce-documentation/mkdocs.yml at main · DataRecce/recce-documentation · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
site_name: Recce
site_description: >-
  Data change validation for dbt projects -
  Create 'all signal, no noise' pull request comments

copyright: Copyright &copy; 2025 Recce <br /><a href="https://cal.com/team/recce/chat?utm_source=banner&utm_campaign=oss" target="_blank" /><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-light.svg" /></a>

# Repository
repo_name: datarecce/recce
repo_url: https://github.com/datarecce/recce
site_url: https://datarecce.io
extra_css:
  - styles/extra.css

extra:
  analytics:
    provider: google
    property: G-E06MSTE2SX
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/HUUx9fyphJ
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/datarecce
    - icon: fontawesome/brands/bluesky
      link: https://x.com/datarecce
    - icon: fontawesome/brands/mastodon
      link: https://mastodon.social/@DataRecce
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/datarecce
    - icon: fontawesome/brands/medium
      link: https://medium.com/inthepipeline
    - icon: fontawesome/brands/github
      link: https://github.com/DataRecce/recce
    - icon: fontawesome/brands/slack
      link: https://getdbt.slack.com/archives/C05C28V7CPP

nav:
  - index.md
  - Guides:
      - Overview:
          - docs/index.md
          - docs/demo.md
      - Getting Started:
          - docs/get-started.md
          - docs/get-started-jaffle-shop.md
          - docs/installation.md
          - docs/start-with-dbt-cloud.md
      - Web UI:
          - docs/features/lineage.md
          - docs/features/query.md
          - docs/features/checklist.md
      - Command Line Interface:
          - docs/features/recce-run.md
          - docs/features/recce-summary.md
      - Advanced Features:
          - docs/features/state-file.md
          - docs/features/preset-checks.md
          - docs/features/node-selection.md
          - docs/features/breaking-change-analysis.md
          - docs/features/column-level-lineage.md
          - docs/reference/configuration.md
      - Scenarios:
          - docs/guides/scenario-dev.md
          - docs/guides/scenario-pr-review.md
          - docs/guides/scenario-ci.md
          - docs/guides/best-practices-prep-env.md
      - Architecture:
          - docs/architecture/overview.md
      - Privacy & Terms:
          - docs/agreement/privacy-policy.md
          - docs/agreement/cookies-policy.md
          - docs/agreement/terms-of-use.md
  - Cloud (Alpha):
      - docs/recce-cloud/index.md
      - docs/recce-cloud/getting-started-recce-cloud.md
      - docs/recce-cloud/setup-gh-actions.md
      - docs/recce-cloud/setup-gh-codespaces.md
      - docs/recce-cloud/expose-recce-instance-visibility.md
      - docs/recce-cloud/share-recce-session-securely.md
      - Cloud Architecture:
          # - docs/recce-cloud/architecture/index.md
          - docs/recce-cloud/architecture/security.md
  #- Blog: "https://medium.com/inthepipeline"
  - Blog:
      - blog/index.md
      - blog/tags.md

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
        #- toc:
        #   title: On this page


  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true

theme:
  name: material
  custom_dir: material/overrides
  logo: assets/images/recce-logo-white.png
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: deep orange
      toggle:
        icon: material/brightness-4 # Icon to switch to dark mode
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: deep orange
      toggle:
        icon: material/brightness-7 # Icon to switch back to light mode
        name: Switch to light mode

  features:
    # - navigation.instant
    # - navigation.instant.progress
    - navigation.tabs
    - navigation.sections
    - content.code.copy

plugins:
  - search
  - tags:
      tags_file: blog/tags.md
  - glightbox:
      skip_classes:
        - skip-glightbox
  - social:
      cards_layout_options:
        background_color: "#ff6e41"
  - blog:
      blog_dir: blog
      archive: true
      post_dir: "{blog}/posts"
      categories_name: Categories
      post_url_format: "{slug}" # Removed date from URL "{date}/{slug}"
      blog_toc: false # enable for blog, archive and category index pages
      #archive_toc: false    # enable for archive index pages
      # categories_toc: true # enable for category index pages

watch:
  - material