orbit/orbit-client-docs
orbit/orbit-client-docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: cover addCommand/addShortcut/addTheme/notify, branding.links + accent, spoilers

Browse source
This commit is contained in:
orbit-docs 2026-07-04 03:23:55 +00:00
parent 572a9d9c5f
commit f06cc502f0
No known key found for this signature in database
3 changed files with 29 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/config.md
View file

@ -25,6 +25,8 @@ Merge rules: objects merge key-by-key; **arrays and scalars replace** wholesale.
| `branding.url` | string | Homepage (used in CTCP VERSION/SOURCE). |
| `branding.tagline` / `taglineEm` / `subtitle` | string | Connect-screen copy. |
| `branding.projectUrl` | string | Orbit project/source link (Settings → About). |
| `branding.links` | array | Extra `{label, url}` rows added to Settings → About. |
| `branding.accent` | string | Overrides the `--accent` CSS colour (e.g. `#ff6b00`); empty keeps the theme default. |
| `turnstile.enabled` | bool | Render the anti-bot challenge inline (Cloudflare Turnstile). `false` = show the server's verification step as a link, no Cloudflare script. Whether a challenge is *required* is decided server-side. |
| `turnstile.sitekey` | string | Public Turnstile site key. |
| `report.service` | string | Services pseudo-client that receives reports (e.g. `ReportServ`) — not blocked by a `+n` staff channel. Empty = fall back to `report.target`. |