-
Notifications
You must be signed in to change notification settings - Fork 5
/
retype.yml
184 lines (144 loc) · 8.28 KB
/
retype.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
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
input: ./docs # The local path from this retype.yml file to your content files.
# -----------------------------------------------------------------------------
output: ./public # Custom path to the output directory.
# -----------------------------------------------------------------------------
url: https://docs.2fauth.app # The base URL of your website.
# -----------------------------------------------------------------------------
poweredByRetype: true # Set to false to remove the Powered by Retype branding.
# -----------------------------------------------------------------------------
branding:
title: 2FAuth # Your custom website title; keep it short.
logo: static/2fauth_dark.png # Path to a logo file.
logoDark: static/2fauth_light.png # Path to a logo file to use in dark mode.
logoAlign: #right # Align the logo to the right or the left.
label: v5.2 # Optional label. To remove the label, remove this config.
# colors:
# label: # Label colors
# text: "#ffffff" # Custom color for the label text.
# background: "#ff0000" # Custom color for the label background.
# -----------------------------------------------------------------------------
links: # A list of custom links to add to the top bar of the generated website.
# See also: footer.links
- text: Home # The text to use for the link
link: https://docs.2fauth.app/ # Link to an internal file or external URL.
icon: home
- text: Demo
link: https://demo.2fauth.app/
icon: beaker
target: blank
- text: API Doc
link: /resources/rapidoc.html # Link to an internal file or external URL.
icon: code-square # A custom icon name, :emoji:, <svg>, or path to a file.
iconAlign: left # Icon alignment, to the left or right. Default is left.
target: blank # Custom target. Use blank to open link in a new window.
- text: Translate
link: https://crowdin.com/project/2fauth
icon: globe
target: blank
- text: GitHub
link: https://github.com/Bubka/2FAuth
icon: mark-github
target: blank
# -----------------------------------------------------------------------------
footer:
copyright: "© Bubka – licensed under a [Creative Commons BY-SA 4.0 License](https://github.com/Bubka/2FAuth-Docs/blob/main/LICENSE)" # A custom copyright statement.
links: # A list of links to include in the footer.
# See also: links
- text: '@2FAuth'
icon: static/icon_mastodon.png
link: https://fosstodon.org/@2fauth
target: blank
- text: 'TwoFAuth'
icon: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M19 0h-14c-2.761 0-5 2.239-5 5v14c0 2.761 2.239 5 5 5h14c2.762 0 5-2.239 5-5v-14c0-2.761-2.238-5-5-5zm-.139 9.237c.209 4.617-3.234 9.765-9.33 9.765-1.854 0-3.579-.543-5.032-1.475 1.742.205 3.48-.278 4.86-1.359-1.437-.027-2.649-.976-3.066-2.28.515.098 1.021.069 1.482-.056-1.579-.317-2.668-1.739-2.633-3.26.442.246.949.394 1.486.411-1.461-.977-1.875-2.907-1.016-4.383 1.619 1.986 4.038 3.293 6.766 3.43-.479-2.053 1.08-4.03 3.199-4.03.943 0 1.797.398 2.395 1.037.748-.147 1.451-.42 2.086-.796-.246.767-.766 1.41-1.443 1.816.664-.08 1.297-.256 1.885-.517-.439.656-.996 1.234-1.639 1.697z"/></svg>
link: https://twitter.com/TwoFAuth # Point to an internal file or external URL.
target: blank
- text: Like 2FAuth? Leave a tip
icon: static/icon_kofi.png
link: https://ko-fi.com/bubka
target: blank
- text: or Sponsor me
icon: heart
link: https://github.com/sponsors/Bubka
target: blank
iconAlign: right
# -----------------------------------------------------------------------------
cache:
strategy: query # Cache busting strategy.
# Options include: none | path | query (default)
# -----------------------------------------------------------------------------
cname: false # The CNAME file value, or false to not create a CNAME file.
# -----------------------------------------------------------------------------
edit:
repo: "https://github.com/Bubka/2FAuth-Docs" # The URL where the source files for this project are located.
base: "docs" # Otional base path to a directory within the above repo.
branch: "" # Point to a custom branch within the repo.
label: "Edit this page" # A custom label for the generated link.
# -----------------------------------------------------------------------------
editor: # Configure the page live editor functionality that is only
# available when `retype watch` is running.
enabled: true # Set to false to disable and hide the live editor.
# -----------------------------------------------------------------------------
exclude: # A list of files or folders to exclude from the build process.
# See also: include
- "*_temp/" # Wildcards are valid.
- "/src/temp.md" # Exclude a specific file.
# -----------------------------------------------------------------------------
favicon: static/2fauth_favicon.png # Path to a custom favicon, or.
# just put a favicon.ico in your project root.
# -----------------------------------------------------------------------------
include: # A list of files or folders to include in the build process.
# See also: exclude
- "*.py" # Wildcards are valid.
# -----------------------------------------------------------------------------
integrations:
googleAnalytics:
id: "" # Your Google Analytics measurement id.
googleTagManager:
id: "" # Your Google Tag Manager measurement id.
gravatar:
default: mp # What Gravatar profile image to use.
# Options include:
# 404 | mp (default) | identicon | monsterid
# wavatar | retro | robohash | blank
enabled: false # Whether Retype should use Gravatar to pull profile images.
plausible: # Plausible.io integration.
domain: # Your plausible Domain(s).
# -----------------------------------------------------------------------------
markdown: # Markdown configuration options.
lineBreaks: soft # Switches between `soft` and `hard` line break modes.
# -----------------------------------------------------------------------------
meta:
title: " - 2FAuth Docs" # Appended to the <title> element on all pages.
# -----------------------------------------------------------------------------
search: # Custom configuration of the website search component.
hotkeys:
- "/" # Keyboard key to set the cursor focus into the search field.
maxResults: 20 # Max number of search results to render.
minChars: 2 # Min number of characters required to trigger a sear.ch
mode: full # The search index creation mode.
# Options include: full | partial | basic
noResultsFoundMsg: "No results" # Message when no results are found.
placeholder: Search # Placeholder text used in the search input field.
# -----------------------------------------------------------------------------
serve:
host: 127.0.0.1 # Serve the website from this host location.
port: 5005 # A custom port configurated separately from host.
watch:
mode: memory # Where to host files from during retype watch.
# Options include: memory (default) | disk
polling: true # How Retype will listen for file changes.
# Options include: false (default) | true | number
validation: optimal # How thorough Retype is looking for changed files.
# Options include: fast | full | optimal (default)
# -----------------------------------------------------------------------------
snippets: # Custom code snippets configuration.
# See: https://retype.com/components/code-snippet
lineNumbers: # A list of language strings to enable line numbering on.
- js
- none # Use `none` to disable line-numbering on snippets.
# -----------------------------------------------------------------------------
templating:
enabled: true # Enable or disable the Retype content templating engine.
liquid: false # Is Liquid syntax {% ... %} enabled?
# If true, Retype is incompatible with
# GitBook style of component configuration.