Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
170 lines (170 loc) · 7.02 KB
/
Copy pathmkdocs.yml
File metadata and controls
170 lines (170 loc) · 7.02 KB
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
site_name: EmailVerify Bot
site_description: A Discord bot that verifies users own a specific email address, with domain-based access control and privacy-first storage.
site_url: https://getemailverified.com/
site_author: Lars Kaesberg
repo_url: https://github.com/lkaesberg/EmailVerify
copyright: >
© WKSolutions GbR — EmailVerify is free software under
<a href="https://github.com/lkaesberg/EmailVerify/blob/main/LICENSE">AGPL-3.0-or-later</a>.
· <button type="button" class="ev-consent-open" data-ev-consent-open>Privacy settings</button>
theme:
name: material
custom_dir: overrides
icon:
repo: fontawesome/brands/github
logo: https://raw.githubusercontent.com/lkaesberg/EmailBot/main/images/emailbot.png
# Default tag only; the real set of icons (opaque PNGs + rounded SVG) is in
# overrides/main.html — see the note there.
favicon: assets/favicon-32x32.png
palette:
# Follows the visitor's OS preference by default; the header toggle overrides it.
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: green
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: green
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- navigation.top
- navigation.instant
- navigation.instant.progress
- navigation.indexes
- navigation.footer
- toc.follow
- content.code.copy
- content.code.annotate
- content.tooltips
- search.suggest
- search.highlight
- search.share
# Internal working documents that live next to the pages but must not be published.
exclude_docs: |
/POSITIONING.md
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/extra.js
# Adds ?v=<content hash> to the two files above. Cloudflare caches them for
# hours while serving HTML fresh — see the note in the hook.
hooks:
- hooks/cache_bust.py
markdown_extensions:
- admonition
- attr_list
- md_in_html
- tables
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.keys
- toc:
permalink: true
plugins:
- search
extra:
# Site name Google should show above search results, fed into og:site_name
# and the WebSite JSON-LD in overrides/main.html. It MUST be unique on the
# web: plain "EmailVerify" is already the site name of emailverify.com/.io/.co
# (global email-validation services) and Google refuses to give one name to
# two global sites — it showed the bare domain for three weeks instead.
# Platform-neutral on purpose (Telegram is planned), so not "… for Discord".
# Keep this identical to site_name and the homepage H1; Google cross-checks.
brand: EmailVerify Bot
# Fallbacks Google may pick if it rejects `brand`. Docs recommend listing the
# lowercase domain as the last resort.
brand_alternates:
- EmailVerify
- GetEmailVerified
- getemailverified.com
social:
- icon: fontawesome/brands/discord
link: https://discord.com/invite/fEBSHUQXu2
name: Support Discord
- icon: fontawesome/brands/github
link: https://github.com/lkaesberg/EmailVerify
name: GitHub repository
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/watch?v=LMWu3Ui2IAk
name: Setup video
# Social-preview banner, consumed by overrides/main.html for the Open Graph /
# Twitter / Discord embed. This MUST be an absolute URL — link scrapers do not
# resolve relative paths. A page can override it with `image:` in front matter.
image: https://getemailverified.com/assets/og-image.png
image_alt: >-
EmailVerify — email verification for Discord servers. Verify members by
domain in 30 seconds. 6-digit code, @*.edu wildcards, open source.
# Actual pixels of docs/assets/og-image.png — a @2x export of the 1200x630
# Open Graph size. Discord and Slack use these to reserve the embed's shape
# before the image arrives; without them a wide banner can flash as a square.
image_width: "2400"
image_height: "1260"
# Subtext line under the title in the Discord link preview (component embed
# in overrides/main.html). Keep it short — it renders as a single small line.
discord_embed_tagline: Discord app · Set up in 60 seconds · Open source since 2021
invite_url: https://discord.com/api/oauth2/authorize?client_id=895056197789564969&permissions=268553344&scope=bot%20applications.commands
# Website analytics: PostHog EU cloud, the same project as the bot (229311), loaded
# by docs/javascripts/extra.js only after the visitor allows it in the consent
# banner ("Privacy settings" in the footer reopens it). Cookieless: the library
# keeps its state in memory only; the stored consent choice is the one thing kept
# on the device. It records page views and clicks on invite, store and support
# links. Delete posthog_key to switch analytics and the banner off entirely.
# Described in docs/legal/datenschutz.md section 4.1 — keep them in step.
# The key is PostHog's public project token, meant to be embedded in web pages.
posthog_key: phc_q4bpaACna8GqogvGLX2jPdryvKrbvaAxvDqmxKB6m2kb
posthog_host: https://eu.i.posthog.com
# UTM convention for links that point at this site, so the analytics can tell
# where visitors came from:
# utm_source where the link lives: bot | email | topgg | discordbotlist |
# discordbotsgg | reddit | youtube | blog
# utm_medium the placement: listing | verify_success | nudge | verification | post
# utm_campaign optional, for a time-boxed push (e.g. intake-2026-10)
nav:
- Home: 'index.md'
- Get started:
- 'Quick start': 'setup.md'
- 'All commands': 'commands.md'
- 'Compare alternatives': 'compare.md'
- 'Allowed-email API': 'api.md'
- Use cases:
- 'Use cases': 'use-cases/index.md'
- 'Universities & schools': 'use-cases/university.md'
- 'Companies & teams': 'use-cases/company.md'
- 'Courses, events & hackathons': 'use-cases/communities.md'
- Premium: 'premium.md'
- Project:
- Statistics: 'statistics.md'
- Status: 'status.md'
- Contributors: 'contributing.md'
- Legal:
- Legal: 'legal/index.md'
- Imprint (Impressum): 'legal/impressum.md'
- Privacy (Datenschutz): 'legal/datenschutz.md'
- AGB (German terms of sale): 'legal/agb.md'
- Cancellation (Widerruf): 'legal/widerruf.md'
- Terms: 'legal/terms.md'
- AV-Vertrag (DPA): 'legal/avv.md'
- Buy Me a Coffee❤️: https://buymeacoffee.com/sral12486