gravitee-se-docs/mkdocs.yml at master · dobl1/gravitee-se-docs · 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
# Project information
site_name: Gravitee.io Solution Engineer Documentation
site_url: https://dobl1.github.io/gravitee-se-docs
site_author: Dorian BLANC

# Repository
repo_url: https://github.com/dobl1/gravitee-se-docs
repo_name: gravitee-se-docs

# Configuration
theme:
  name: material
  custom_dir: overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  language: en
  logo: assets/logo-white.png
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - content.code.annotate
    - content.tabs.link
    - search.suggest
    - search.share
    - announce.dismiss

# Extra CSS
extra_css:
  - stylesheets/extra.css

# Plugins
plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
  # - mike:
  #   alias_type: symlink
  #   redirect_template: null
  #   deploy_prefix: ''
  #   canonical_version: null
  #   version_selector: true
  #   css_dir: css
  #   javascript_dir: js
  # - tags:
  #   tags_file: tags.md

# Customization
extra:
  generator: false
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/GraviteeIO
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/c/Graviteesource
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/gravitee-io
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/gravitee.io
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/u/graviteeio
    - icon: fontawesome/brands/github
      link: https://github.com/gravitee-io
    - icon: fontawesome/solid/link
      link: https://www.gravitee.io
#   alternate:
#     - name: English
#       link: /en/
#       lang: en
#     - name: Français
#       link: /fr/
#       lang: fr

# Extensions
markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 4
  - meta
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

# Page tree
nav:
  - Home: index.md
  - API Management:
    - api-management/index.md
    - Architecture:
      - api-management/architecture/index.md
      - Self-Hosted: api-management/architecture/self-hosted.md
      - Hybrid: api-management/architecture/hybrid.md
    - Installation:
      - Hybrid: api-management/install/hybrid.md
      - Reference Architecture: api-management/install/reference-architecture.md
  - Access Management: access-management/index.md
  - API Designer: api-designer/index.md
  - Alert Engine: alert-engine/index.md
  - Cockpit: cockpit/index.md
  - Tags: tags.md