-
Notifications
You must be signed in to change notification settings - Fork 3
/
config.yaml
188 lines (160 loc) · 7.15 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
baseURL: "https://aqua-protocol.org"
title: "AQUA Protocol"
enableRobotsTXT: true
theme: "docsy"
enableGitInfo: true
# Language settings
contentDir: "content/en"
defaultContentLanguage: "en"
defaultContentLanguageInSubdir: false
enableMissingTranslationPlaceholders: true
# Comment out to enable taxonomies in Docsy
# disableKinds: ["taxonomy", "taxonomyTerm"]
# You can add your own taxonomies
taxonomies:
tag: "tags"
category: "categories"
taxonomy:
# set taxonomyCloud: [] to hide taxonomy clouds
taxonomyCloud: ["tags", "categories"]
# If used, must have same lang as taxonomyCloud
taxonomyCloudTitle: ["Tag Cloud", "Categories"]
# set taxonomyPageHeader: [] to hide taxonomies on the page headers
taxonomyPageHeader: ["tags", "categories"]
# Highlighting config
pygmentsCodeFences: true
pygmentsUseClasses: false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic: false
#pygmentsOptions: "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle: "tango"
# Configure how URLs look like per section.
permalinks:
blog: "/:section/:year/:month/:day/:slug/"
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
blackfriday:
plainIDAnchors: true
hrefTargetBlank: true
angledQuotes: false
latexDashes: true
# Image processing configuration.
imaging:
resampleFilter: "CatmullRom"
quality: 75
anchor: "smart"
services:
googleAnalytics:
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
# id: "UA-00000000-0"
# Language configuration
languages:
en:
title: "AQUA Protocol"
description: "Welcome to the AQUA Protocol, a simple and novel approach to prove integrity of data, authorship, and time!"
languageName: "English"
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
# Comment out if you don't want the "print entire section" link enabled.
outputs:
section: ["HTML", "print"]
params:
copyright: "AQUA Protocol"
privacy_policy: "https://aqua-protocol.org/privacy"
# First one is picked as the Twitter card image if not set on page.
# images: ["images/project-illustration.png"]
# 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: "Releases"
# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version: false
# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version: "0.0"
# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version: "https://aqua-protocol.org"
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo: "https://github.com/inblockio/aqua-docs"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo: "https://github.com/inblockio/aqua-pkc"
# Specify a value here if your content directory is not in your repo's root directory
# github_subdir: ""
# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
github_branch: "main"
# Google Custom Search Engine ID. Remove or comment out to disable search.
gcs_engine_id: false
# Enable Algolia DocSearch
algolia_docsearch: false
# Enable Lunr.js offline search
offlineSearch: true
offlineSearchSummaryLength: 200
offlineSearchMaxResults: 25
# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting: false
# User interface configuration
ui:
# Set to true to disable breadcrumb navigation.
breadcrumb_disable: false
# Set to true to disable the About link in the site footer
footer_about_disable: false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
navbar_logo: true
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
navbar_translucent_over_cover_disable: false
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact: 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: 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/inblockio/aqua-docs/issues/new">tell us how we can improve</a>.'
no: 'Sorry to hear that. Please <a href="https://github.com/inblockio/aqua-docs/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
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: "User mailing list"
url: "mailto:[email protected]"
icon: "fa fa-envelope"
desc: "Discussion and help from your fellow users"
- name: "Twitter"
url: "https://twitter.com/inblockio"
icon: "fab fa-twitter"
desc: "Follow inblock.io on Twitter for latest news!"
- name: "Matrix"
url: "https://matrix.to/#/#aqua-community:matrix.jembawan.com"
icon: "fa fa-comment"
desc: "Chat with other project developers on Matrix"
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
developer:
- name: "GitHub"
url: "https://github.com/inblockio"
icon: "fab fa-github"
desc: "AQUA development takes place here!"
- name: "Stack Overflow"
url: "https://stackoverflow.com/questions/tagged/aqua"
icon: "fab fa-stack-overflow"
desc: "Questions and curated answers by developers working with AQUA"