Orbit documentation: docs, wiki and FAQ pages
This commit is contained in:
commit
bcbe5fff22
18 changed files with 714 additions and 0 deletions
51
docs/branding.md
Normal file
51
docs/branding.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# Branding & themes
|
||||
|
||||
Everything that ties Orbit to a particular network or brand lives in
|
||||
[`config.json`](/docs/config/) under `branding` and `defaults` — no code changes, no rebuild.
|
||||
|
||||
## Rebrand
|
||||
|
||||
```json
|
||||
{
|
||||
"branding": {
|
||||
"name": "ExampleChat",
|
||||
"icon": "https://example.org/logo.svg",
|
||||
"url": "https://example.org",
|
||||
"tagline": "Chat with",
|
||||
"taglineEm": "everyone.",
|
||||
"subtitle": "Public rooms, private messages, no signup required."
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This changes the connect screen, the console title, the network icon, and the CTCP VERSION/SOURCE
|
||||
replies the client sends.
|
||||
|
||||
## Themes
|
||||
|
||||
Orbit ships four themes:
|
||||
|
||||
- **light** — clean, default.
|
||||
- **dark** — easy on the eyes.
|
||||
- **yomirc** — a retro mIRC / Windows-95 skin (silver chrome, fixed-width log lines).
|
||||
- **yomirc-dark** — the retro skin in a dark palette.
|
||||
|
||||
Set the default for new users:
|
||||
|
||||
```json
|
||||
{ "defaults": { "theme": "dark" } }
|
||||
```
|
||||
|
||||
Users can switch any time in **Settings → Appearance**. See the [Themes wiki page](/wiki/themes/).
|
||||
|
||||
## Feature flags
|
||||
|
||||
Hide whole features per deployment:
|
||||
|
||||
```json
|
||||
{ "features": { "push": true, "imageUpload": true, "register": false } }
|
||||
```
|
||||
|
||||
- `push` — the Web Push notifications row.
|
||||
- `imageUpload` — the composer image button + paste/drag upload.
|
||||
- `register` — the "create an account" tab.
|
||||
Loading…
Add table
Add a link
Reference in a new issue