clevercloud-php-sdk/mkdocs.yml at main · welcoMattic/clevercloud-php-sdk · 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
site_name: Clever Cloud PHP SDK
site_description: PHP SDK for the Clever Cloud REST API (v2 + v4 + api-bridge)
site_url: https://welcomattic.github.io/clevercloud-php-sdk/
repo_name: welcoMattic/clevercloud-php-sdk
repo_url: https://github.com/welcoMattic/clevercloud-php-sdk
edit_uri: edit/main/docs/

docs_dir: docs

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.footer
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.action.edit
    - content.action.view
    - toc.follow
  palette:
    scheme: default
    primary: custom
    accent: custom
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

extra_css:
  - stylesheets/clevercloud.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/welcoMattic/clevercloud-php-sdk
    - icon: fontawesome/brands/php
      link: https://packagist.org/

nav:
  - Home: index.md
  - Guides:
      - Getting started: getting-started.md
      - Authentication: authentication.md
      - Configuration: configuration.md
      - Error handling: errors.md
      - Live log streaming: logs-streaming.md
      - Testing: testing.md
  - V2 resources:
      - Self: resources/self.md
      - Users: resources/users.md
      - Organisations: resources/organisations.md
      - Applications: resources/applications.md
      - Add-ons: resources/addons.md
      - Deployments: resources/deployments.md
      - Environment: resources/environment.md
      - Domains: resources/domains.md
      - TCP redirections: resources/tcp-redirections.md
      - Products: resources/products.md
      - Instances: resources/instances.md
  - V4 resources:
      - Billing: resources/billing.md
      - Load balancers: resources/load-balancers.md
      - Zones: resources/zones.md
      - Logs: resources/logs.md
      - Operators: resources/operators.md
      - Drains: resources/drains.md
      - Notifications: resources/notifications.md
      - Webhooks: resources/webhooks.md
      - Network groups: resources/network-groups.md
      - Orchestration: resources/orchestration.md
      - Pulsar policies: resources/pulsar-policies.md
      - Backups: resources/backups.md
  - Bridge:
      - API tokens: resources/api-tokens.md

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      extend_pygments_lang:
        - name: php
          lang: php
          options:
            startinline: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search