You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update README and CLAUDE.md for contact card system
Add contact card documentation with all 8 supported types,
variable reference for speedtest_url, and development notes
for main.py hook and MkDocs v1 pin.
Copy file name to clipboardExpand all lines: README.md
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,6 +125,33 @@ Set to `true` to show the section, `false` to hide it.
125
125
| `has_migration` | `false` | Watch history migration section |
126
126
| `show_costs` | `false` | Server cost information |
127
127
| `server_cost` | `""` | Monthly cost string |
128
+
| `speedtest_url` | `""` | Speed test URL (falls back to `fast.com`) |
129
+
130
+
### Contact Card
131
+
132
+
The `contact_methods` variable configures a bot-protected contact card at the bottom of the guide. Values are base64-encoded at build time and decoded by JavaScript at runtime.
133
+
134
+
```yaml
135
+
contact_methods:
136
+
- type: signal_url
137
+
label: "Message on Signal"
138
+
value: "https://signal.me/#eu/..."
139
+
preferred: true # Shows a "preferred" badge
140
+
- type: email
141
+
label: "Email"
142
+
value: "admin@example.com"
143
+
```
144
+
145
+
| Type | Behavior | Value Format |
146
+
|------|----------|--------------|
147
+
| `email` | `mailto:` link | `admin@example.com` |
148
+
| `phone` | `tel:` link | `+15551234567` |
149
+
| `signal_url` | Clickable Signal invite | `https://signal.me/#eu/...` |
150
+
| `signal_username` | Plain text (no link) | `username.123` |
0 commit comments