teamster/mkdocs.yml at main · TEAMSchools/teamster · 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
# yaml-language-server: $schema= customTags=["tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji scalar","tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg scalar"]
# https://www.mkdocs.org/user-guide/configuration/
# https://squidfunk.github.io/mkdocs-material/setup/

site_name: teamster
site_description: Data engineering platform for KIPP TEAM & Family Schools
repo_url: https://github.com/TEAMSchools/teamster
repo_name: TEAMSchools/teamster
edit_uri: edit/main/docs/
copyright: Copyright &copy; KIPP TEAM & Family Schools

theme:
  name: material
  favicon: images/truck.svg
  logo: images/truck.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - content.action.edit
    - content.code.copy
    - navigation.instant
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow

hooks:
  - docs/hooks.py

nav:
  - Home: README.md
  - Guides:
      - guides/index.md
      - Codespaces: guides/codespaces.md
      - Local Development: guides/local-development.md
      - Dagster: guides/dagster.md
      - Google Sheets & Forms: guides/google-sheets.md
      - dbt Development: guides/dbt-development.md
      - SFTP Integration: guides/sftp-integration.md
      - Claude Code & Superpowers: guides/superpowers.md
  - Troubleshooting:
      - Dagster: troubleshooting/dagster.md
      - dbt: troubleshooting/dbt.md
      - VS Code: troubleshooting/vscode.md
  - Reference:
      - Architecture: reference/architecture.md
      - Adding an Integration: reference/adding-an-integration.md
      - IO Managers: reference/io-managers.md
      - Fiscal Year & Partitioning: reference/fiscal-year-partitioning.md
      - dbt Conventions: reference/dbt-conventions.md
      - Automation Conditions: reference/automation-conditions.md
  - Automations: reference/automations.md

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true