datafoundry/mkdocs.yml at main · datagallery-lab/datafoundry · 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
site_name: DataFoundry
site_description: Governed data-agent workbench for enterprise data tasks.
site_url: https://datagallery-lab.github.io/datafoundry/
repo_name: datagallery-lab/datafoundry
repo_url: https://github.com/datagallery-lab/datafoundry
edit_uri: edit/main/docs/

exclude_docs: |
  README.md
  en/README.md
  zh/README.md

not_in_nav: |
  zh/*.md
  zh/**/*.md

theme:
  name: material
  icon:
    logo: material/database
  language: en
  palette:
    - scheme: default
      primary: white
      accent: blue
  features:
    - content.action.edit
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.suggest

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/language-switcher.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/datagallery-lab/datafoundry
  alternate:
    - name: English
      link: en/
      lang: en
    - name: 简体中文
      link: zh/
      lang: zh

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - toc:
      permalink: true

nav:
  - Home: index.md
  - User Guide:
      - en/index.md
      - Product overview: en/overview.md
      - Quick start: en/quick-start.md
      - Capabilities: en/capabilities.md
      - Guides:
          - Web workbench: en/guides/web-workbench.md
          - TUI: en/guides/tui.md
          - Data sources: en/guides/data-sources.md
      - Examples:
          - DTC growth operating review: en/examples/dtc-growth-demo.md
  - Developer Guide:
      - Architecture:
          - Overview: en/architecture/overview.md
      - Security: en/security.md
  - API Reference:
      - REST API: en/reference/rest-api.md
      - Configuration API: en/reference/configuration-api.md
      - Agent Runtime: en/reference/agent-runtime.md
      - Supported data sources: en/reference/supported-datasources.md
  - Community:
      - en/community/index.md
      - Contact us: en/community/contact-us.md
      - Contributing: en/community/contributing.md
      - Scenario cases: en/community/scenario-cases.md
      - Collaboration policy: en/community/collaboration-policy.md