documentation/hugo.yaml at main · CleverCloud/documentation · 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
baseURL: https://www.clever.cloud/developers
title: Clever Cloud Documentation
publishDir: public/developers

module:
  imports:
  - path: github.com/imfing/hextra
  hugoVersion:
    extended: true
    min: 0.151.0

disableKinds:
  - taxonomy
  - term

enableEmoji: true
enableGitInfo: true
enableInlineShortcodes: true
hasCJKLanguage: true

languageCode: en-US

markup:
  highlight:
    noClasses: false
  goldmark:
    renderer:
      unsafe: true
    extensions:
      passthrough:
        delimiters:
          block: [['\[', '\]'], ['$$', '$$']]
          inline: [['\(', '\)']]
        enable: true

menu:
  main:
    - identifier: documentation
      name: Documentation
      pageRef: /doc/
      weight: 1
    - identifier: tutorials
      name: Guides
      pageRef: /guides/
      weight: 2
    - identifier: api
      name: API
      weight: 3
    - name: "How to use"
      parent: api
      url: "/api/howto"
    - name: "v2 endpoints"
      parent: api
      url: "/api/v2"
    - name: "v4 endpoints"
      parent: api
      url: "/api/v4"
    - identifier: changelog
      name: Changelog
      pageRef: /changelog/
      weight: 4
    - identifier: components
      name: Web Components
      url: https://www.clever.cloud/developers/clever-components/
      weight: 5
    - name: Search
      weight: 6
      params:
        type: search
    - name: GitHub
      weight: 7
      url: https://github.com/CleverCloud/documentation/
      params:
        icon: github
    - name: Website
      weight: 8
      url: https://www.clever.cloud/
      params:
        icon: globe-alt

  sidebar:
    - identifier: more
      name: References
      params:
        type: separator
      weight: 1
    - identifier: tips_and_tricks
      name: Tips & Tricks
      url: /doc/best-practices/tips_and_tricks/
      weight: 2
    - identifier: cli
      name: Clever Tools CLI
      url: /doc/reference/cli/
      weight: 3
    - identifier: envar
      name: Environment Variables
      pageRef: /doc/reference/reference-environment-variables
      weight: 4
    - identifier: common
      name: Common Configuration
      pageRef: /doc/develop/common-configuration/
      weight: 5
    - identifier: postmortem
      name: Postmortem
      pageRef: /postmortem/
      weight: 6

outputs:
  home: [HTML, LLMS]
  page: [HTML, Markdown]
  section: [HTML, Markdown, RSS]

outputFormats:
  LLMS:
    mediaType: text/plain
    baseName: llms
    isPlainText: true

  Markdown:
    baseName: index.html

pagination:
  pagerSize: 21 # Number of entries in Changelog section before pagination

params:
  blog:
    list:
      displayTags: true
      # date | lastmod | publishDate | title | weight
      sortBy: date
      sortOrder: desc # or "asc"
      pagerSize: 20

    article:
      displayPagination: true

  description: Clever Cloud is a Platform-as-a-Service (PaaS) cloud provider, an automated hosting platform for developers. Deploy your app easily and launch dependencies without having to worry about the infrastructure set up.

  displayUpdatedDate: true
  dateFormat: January 2, 2006

  editURL:
    enable: true
    base: https://github.com/CleverCloud/documentation/edit/main/content/

  externalLinkDecoration: true

  footer:
    enable: false
    displayCopyright: false
    displayPoweredBy: false
    width: normal

  highlight:
    copy:
      enable: true
      # hover | always
      display: hover

  images:
  - images/feature.png

  navbar:
    displayTitle: false
    displayLogo: true
    logo:
      path: images/logo.svg
      dark: images/logo-dark.svg
      link: /developers
      width: 175
    width: wide

  page:
    # full (100%), wide (90rem), normal (1280px)
    width: full
    tabs:
      sync: true

  search:
    enable: true
    type: flexsearch

    flexsearch:
      # index page by: content | summary | heading | title
      index: content
      # full | forward | reverse | strict
      tokenize: forward

  theme:
    # light | dark | system
    default: system
    displayToggle: true

privacy:
  youtube:
    privacyEnhanced: true