-
Notifications
You must be signed in to change notification settings - Fork 59
/
config.yaml
205 lines (172 loc) · 6.48 KB
/
config.yaml
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
197
198
199
200
201
202
203
204
205
baseURL: https://notaryproject.dev/
enableRobotsTxt: true
theme: [docsy]
# Will give values to .Lastmod etc.
enableGitInfo: true
# Language settings
contentDir: content/en
defaultContentLanguage: en
defaultContentLanguageInSubdir: false
languageCode: en-us
# Useful when translating.
enableMissingTranslationPlaceholders: true
disableKinds: [taxonomy, term]
# Highlighting config
pygmentsCodeFences: true
pygmentsUseClasses: false
# Use the new Chroma Go highlighter in Hugo.
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle: fruity # "tango"
# Image processing configuration.
imaging:
resampleFilter: CatmullRom
quality: 75
anchor: smart
languages:
en:
title: Notary Project | A set of specifications and tools intended to provide a cross-industry standard for securing software supply chains.
description: >-
The Notary Project is a set of specifications and tools intended to provide a cross-industry standard for securing software supply chains by using authentic container images and other OCI artifacts.
languageName: English
contentDir: content/en
weight: 1
markup:
goldmark:
renderer:
unsafe: true
highlight:
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style: tango
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax: true
# Everything below this are Site Params
params:
versions:
- version: main
name: main
url: "https://notaryproject.dev/"
- version: v1.2
name: v1.2
url: "https://v1-2.notaryproject.dev/"
- version: v1.1
name: v1.1
url: "https://v1-1.notaryproject.dev/"
- version: v1.0
name: v1.0
url: "https://v1-0.notaryproject.dev/"
version_menu: "Version"
version_menu_pagelinks: true
archived_version: true
version: "0.1"
url_latest_version: "https://notaryproject.dev/docs/"
copyright: Notary Project Authors
description: >-
A distributed, reliable key-value store for the most critical data of a
distributed system
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo: https://github.com/notaryproject/notaryproject.dev
github_branch: main
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo: https://github.com/notaryproject/notaryproject
# Enable Algolia DocSearch
algolia_docsearch: false
# Enable Lunr.js offline search
offlineSearch: false
# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting: true
# Versions
# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
# version_menu: Versions
# versions:
# latest: v2
# all:
# - v2
# - v1
# deprecation_warning: |-
# the documentation is no longer actively maintained.
# The page that you are viewing is the last archived version.
# User interface configuration
ui:
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact: true
# Set to true to disable breadcrumb navigation.
breadcrumb_disable: false
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable: false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo: true
# Set to true to disable the About link in the site footer
footer_about_disable: true
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
feedback:
enable: true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
"yes": >-
Glad to hear it! Please <a
href="https://github.com/notaryproject/notaryproject.dev/issues/new">tell us how we
can improve</a>.
"no": >-
Sorry to hear that. Please <a
href="https://github.com/notaryproject/notaryproject.dev/issues/new">tell us how we
can improve</a>.
# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
readingtime:
enable: false
# Navbar config
navbar:
logos:
github:
url: https://github.com/notaryproject/notaryproject
twitter:
url: https://mobile.twitter.com/NotaryProject
slack:
url: https://app.slack.com/client/T08PSQ7BQ/CQUH8U287/
# Footer Links
links:
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
user:
# - name: Google Group
# url: https://groups.google.com/forum/?hl=en#!forum/etcd-dev
# icon: fab fa-google
# - name: Twitter
# url: https://twitter.com/etcdio
# icon: fab fa-twitter
- name: Stack Overflow
url: https://stackoverflow.com/questions/tagged/notary
icon: fab fa-stack-overflow
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
developer:
- name: Notary Project on GitHub
url: https://github.com/notaryproject/notaryproject
icon: fab fa-github-square
- name: notaryproject.dev on GitHub
url: https://github.com/notaryproject/notaryproject.dev
icon: fab fa-github
# [params.logos]
hero: >-
https://github.com/cncf/artwork/raw/master/projects/notary/horizontal/black/notary-horizontal-black.png
mediaTypes:
text/netlify: {}
outputFormats:
REDIRECTS:
mediaType: text/netlify
baseName: _redirects
notAlternative: true
outputs:
home: [HTML, REDIRECTS, RSS]
# Site menu (partial -- also see pages with 'menu' in front matter)
menu:
main:
- name: Roadmap
url: https://github.com/notaryproject/roadmap
weight: -20
- name: Security
url: ./security-audit/
weight: -50