upcloud-cli/mkdocs.base.yaml at main · UpCloudLtd/upcloud-cli · 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
# Base configuration for documentation.
# Run `python3 .ci/docs/generate_command_reference_nav.py` after generating markdown reference with `go run ./.ci/docs` to generate command reference navigation tree.
site_name: UpCloud command-line client
site_description: upctl provides a command-line interface to UpCloud services. It allows you to control your resources from the command line or any compatible interface.
site_url: https://upcloudltd.github.io/upcloud-cli/
repo_name: UpCloudLtd/upcloud-cli
repo_url: https://github.com/UpCloudLtd/upcloud-cli
copyright: Copyright &copy; 2022 UpCloud Oy

extra_css:
  - extra.css

nav:
  - index.md
  - Commands reference: []
  - Examples: []
  - changelog.md

theme:
  name: material
  custom_dir: .ci/docs/overrides
  palette:
    primary: white
  font:
    text: Source Sans Pro
    code: Source Code Pro
  favicon: favicon.svg
  language: en
  features:
    - content.code.copy
    - navigation.instant

plugins:
  - search
  - macros:
      include_yaml:
        - vars.yaml

extra:
  version:
    default: latest
    provider: mike

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true