documentation/mkdocs.yaml at main · arunaengine/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
site_name: Aruna Documentation
site_url: https://ArunaStorage.github.io/documentation

repo_name: 'arunastorage/api'
repo_url: 'https://github.com/ArunaStorage/api'

docs_dir: docs/

nav:
  - 'Home':
    - 'Aruna overview': index.md
    - 'Getting Started': get_started/basic_usage/00_index.md
  - 'Getting Started':
    - 'Overview': get_started/basic_usage/00_index.md
    - '1 | Get Storage Access': get_started/basic_usage/01_Get-Storage-Access.md
    - '2 | Authorization/Tokens': get_started/basic_usage/02_How-To-Auth-Tokens.md
    - '3 | Licenses': get_started/basic_usage/03_How-To-Licenses.md
    - '4 | Projects': get_started/basic_usage/04_How-To-Project.md
    - '5 | Collections': get_started/basic_usage/05_How-To-Collections.md
    - '6 | Datasets': get_started/basic_usage/06_How-To-Datasets.md
    - '7 | Objects': get_started/basic_usage/07_How-To-Objects.md
    - '8 | Relations': get_started/basic_usage/08_How-To-Relations.md
    - '9 | Notifications': get_started/basic_usage/09_How-To-EventNotification.md
    - '10 | Server Info': get_started/basic_usage/10_How-To-ServerInfo.md
    - '11 | S3 Interface': get_started/basic_usage/11_How-To-S3-Interface.md
    - '12 | Search': get_started/basic_usage/12_How-To-Search.md
    - '13 | Hooks': get_started/basic_usage/13_How-To-Hooks.md
    - '14 | Service Accounts': get_started/basic_usage/14_How-To-ServiceAccount.md
    - '15 | Workspaces': get_started/basic_usage/15_How-To-Workspace.md
  - 'Data Structure':
    - 'Internal Data Structure': internal_data_structure/internal_data_structure.md
    - 'Database ERD': internal_data_structure/database_erd.md
  #- 'Deployment Recipes'
    #- 'ArunaServer': deployment/server.md

theme:
  icon:
    repo: fontawesome/brands/github
  name: material
  logo: assets/logo-claim.png
  favicon: assets/logo-icon.png
  custom_dir: overrides
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - toc.integrate

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - def_list
  - attr_list
  - md_in_html
  - admonition
  - tables
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: false
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons

plugins:
  - glightbox
  - search
  - mike:
      version_selector: true
      css_dir: stylesheets

extra:
  version:
    provider: mike