pipeops-go-sdk/mkdocs.yml at main · PipeOpsHQ/pipeops-go-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
site_name: PipeOps Go SDK Documentation
site_description: Comprehensive documentation for the PipeOps Go SDK
site_author: PipeOps
site_url: https://github.com/PipeOpsHQ/pipeops-go-sdk

repo_name: PipeOpsHQ/pipeops-go-sdk
repo_url: https://github.com/PipeOpsHQ/pipeops-go-sdk
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/PipeOpsHQ
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/PipeOpsHQ

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - Authentication:
    - Overview: authentication/overview.md
    - Basic Auth: authentication/basic-auth.md
    - OAuth 2.0: authentication/oauth.md
  - API Services:
    - Overview: api-services/overview.md
    - Authentication: api-services/auth.md
    - Projects: api-services/projects.md
    - Servers: api-services/servers.md
    - Environments: api-services/environments.md
    - Teams: api-services/teams.md
    - Workspaces: api-services/workspaces.md
    - Billing: api-services/billing.md
    - Add-ons: api-services/addons.md
    - Webhooks: api-services/webhooks.md
    - Users: api-services/users.md
    - Cloud Providers: api-services/cloudproviders.md
    - Service Tokens: api-services/servicetokens.md
    - Miscellaneous: api-services/misc.md
  - Advanced Usage:
    - Error Handling: advanced/error-handling.md
    - Retries & Timeouts: advanced/retries-timeouts.md
    - Rate Limiting: advanced/rate-limiting.md
    - Logging: advanced/logging.md
    - Custom HTTP Client: advanced/custom-http-client.md
  - Examples:
    - Complete Examples: examples/complete-examples.md
    - Common Patterns: examples/common-patterns.md
  - API Reference:
    - Client: reference/client.md
    - Types: reference/types.md
    - Errors: reference/errors.md
  - Development:
    - Contributing: contributing.md
    - Workflows: WORKFLOWS.md
  - Changelog: changelog.md

plugins:
  - search