forked from Consensys/doc.gnark
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
131 lines (124 loc) · 4.08 KB
/
mkdocs.yml
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
# Copyright 2021 ConsenSys AG.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.
# Project information
site_name: gnark
site_url: https://docs.gnark.consensys.net/
site_description: gnark documentation.
site_author: gnark community
copyright: gnark and its documentation are licensed under Apache 2.0 license
#extra project info and template customisation
extra:
content_vars:
gnark_version: "v0.4.0" # this is used in external URL (godoc, ...)
logo_is_text: true
latest_version_warning:
url_contains: /latest/
text: 'You are reading gnark development version documentation and
some displayed features may not be available in the stable release.
You can switch to stable version using the version box at screen bottom.'
support:
tool: discussions
channel: https://github.com/ConsenSys/gnark/discussions
email: zkteam@consensys.net
website: https://github.com/Consensys/gnark
company: Consensys
issues: https://github.com/Consensys/gnark/issues
google:
site_verification: 'VL2MgMm7Gj-fEOH3SkAuP4eXOY7rIShFFbTI5RktuA0' # Google Search Console verif code
tag_manager: 'GTM-M9FMRZ7' # Google tag manager code
# Software Repository
repo_name: ConsenSys/gnark
repo_url: https://github.com/ConsenSys/gnark
theme:
name: material
custom_dir: common/custom_theme
palette:
scheme: consensys-protocol
font:
text: 'Roboto'
code: 'Roboto Mono'
language: 'en'
logo: 'Images/logo.svg'
favicon: 'Images/favicon.svg'
nav:
- How to:
- Add gnark to your project: HowTo/get_started.md
- Write circuits:
- Design considerations: HowTo/write/design_considerations.md
- Circuit structure: HowTo/write/circuit_structure.md
- Circuit API: HowTo/write/circuit_api.md
- Standard library: HowTo/write/standard_library.md
- Conditionals and loops: HowTo/write/instructions.md
- Compile circuits: HowTo/compile.md
- Debug and test circuits: HowTo/debug_test.md
- Create and verify proofs: HowTo/prove.md
- Serialize: HowTo/serialize.md
- Use gnark as a service:
- gnarkd: HowTo/use/gnarkd.md
- Concepts:
- zk-SNARK: Concepts/zkp.md
- Circuits and constraint systems: Concepts/circuits.md
- Proving schemes and curves: Concepts/schemes_curves.md
- Tutorials:
- EdDSA: Tutorials/eddsa.md
- Reference:
- API: Reference/api.md
markdown_extensions:
- toc:
permalink:
toc_depth: 4
- codehilite
- pymdownx.tabbed
- pymdownx.superfences
- markdown_include.include:
base_path: docs
- admonition
- footnotes
- def_list
- abbr
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.keys
- pymdownx.details
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- meta
- smarty
- plantuml_markdown:
server: http://www.plantuml.com/plantuml
plugins:
- search:
lang: 'en'
separator: '[\s\-\.\_]+'
- markdownextradata
- exclude:
glob:
- global/*
- git-revision-date-localized:
locale: en
- minify:
minify_html: true
minify_js: true
htmlmin_opts:
remove_comments: true
- redirects:
redirect_maps:
# Configure redirects using key:value pairs:
# old_path.md: new_path.md
# you can't use an already redirected path as an old_path.
# new_path can be a file inside the docs/ folder or any URL (http://...)
# Reference/EthSigner-CLI.md: Reference/CLI/CLI-Syntax.md