kevel/mkdocs.yml at main · germainlefebvre4/kevel · 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
---
site_name: Kevel
site_description: Kubectl client with frictionless version switching.
site_url: https://kevel.readthedocs.io/

repo_name: germainlefebvre4/kevel
repo_url: https://github.com/germainlefebvre4/kevel

theme:
  name: material
  language: en
  logo: assets/logo.svg
  favicon: assets/logo.svg
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - navigation.footer
    - content.code.copy

plugins:
  - search:
      lang: en
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_if_no_docstring: false
            show_docstring_description: true
            show_docstring_parameters: true
            show_docstring_examples: true
            docstring_section_style: table

nav:
  - Kevel: index.md
  - "Getting started": getting-started.md
  - Contributing: contributing.md
  - FAQ: faq.md

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - codehilite
  - tables
  - footnotes
  - extra
  - mkdocs-click
  - toc:
      permalink: true
  - markdown.extensions.codehilite:
      guess_lang: false
  # - mdx_include:
  #     base_path: docs
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format ''
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details

watch:
  - docs/

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/germainlefebvre4/kevel
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/germainlefebvre4/kevel

copyright: Copyright &copy; 2024 Germain Lefebvre