mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Nick Vigilante
c84aa564ba
Normalizes non-standard code-fence language tags across `docs/**` so a strict highlighter (Shiki, used by Fumadocs) won't fail the build on an unrecognized language, and unifies redundant synonym tags onto one canonical form per language. The current renderer (Speed-Highlight) detects the language from the code content, not the fence label, so this drift wasn't visible until now. ## Changes - `hcl` -> `tf` (199 fences, including indented ones nested in numbered/bulleted lists). Shiki ships `hcl` and `terraform` as two distinct grammars (not aliases); every `hcl`-tagged fence in `docs/**` is actually Terraform resource/data/provider syntax, so the more specific `terraform` grammar is correct for all of them. `tf` is Shiki's own alias for that grammar, and it's also what GitHub's own markdown renderer resolves to the same HCL/Terraform highlighting. - `pwsh`/`powershell` -> `ps1`. Both `ps` and `ps1` are registered PowerShell aliases in Shiki, but on GitHub's renderer only `.ps1` is a registered file extension (`.ps` isn't), so `ps1` renders identically to `powershell` there today while bare `ps` would silently lose highlighting. - `env` -> `dotenv` (a dedicated Shiki grammar for `KEY=VALUE` files) - `text`/`output`/`none`/`url` -> `txt`. Same built-in plain-text fallback either way, just shorter. - `Dockerfile` -> `dockerfile` (lowercase) - `bash`/`shell` -> `sh` (732 fences). Shiki and GitHub both alias all three to a single shell grammar; this was already the style guide's stated preference, just not enforced across the existing corpus until now. - `markdown` -> `md` (4 fences). Alias of the same grammar in both Shiki and GitHub. - `jsonc` -> `json` (1 fence). The block has no comments or trailing commas, so it doesn't need the comments-capable grammar. - `ts` -> `tsx` (2 fences, `docs/about/contributing/frontend.md`). Verified the actual content tokenizes identically under both grammars, and a sibling block in the same file already needs `tsx` for real JSX, so unifying to one tag is safe for this file. Documented a caveat: `tsx` mis-tokenizes the legacy angle-bracket type-assertion syntax (`<Type>value`), which is invalid in real `.tsx` files anyway, so use `value as Type` instead. - `yml` -> `yaml` (1 fence) - Updated `docs/.style/style-guide/formatting.md` to document all canonical tags `promql` (2 fences) and `caddyfile` (2 fences) are left as-is. Shiki doesn't bundle a grammar for either, so they need a custom grammar registration when the site adopts Shiki, rather than degrading to `txt`. Tracked as follow-up work under DOCS-118 and [DOCS-544](https://linear.app/codercom/issue/DOCS-544/vendor-a-local-promql-grammar-for-shiki-syntax-highlighting) (promql). Does not touch `offlinedocs/`. Linear: [DOCS-476](https://linear.app/codercom/issue/DOCS-476/normalize-docs-code-fence-languages-de-risk-shikifumadocs) <details> <summary>How the fence tags were verified</summary> Each tag was tested against a real `shiki@latest` highlighter instance (`codeToHtml`/`codeToTokens`) and cross-checked against GitHub's `@wooorm/starry-night` grammar sources (the renderer that actually displays these `.md` files today, in repo browsing and PR diffs), since that's what determines whether brevity is safe before Shiki adoption: ```text FAIL env -- Language `env` is not included in this bundle. FAIL Dockerfile -- Language `Dockerfile` is not included in this bundle. FAIL promql -- Language `promql` is not included in this bundle. FAIL caddyfile -- Language `caddyfile` is not included in this bundle. FAIL pwsh -- Language `pwsh` is not included in this bundle. FAIL output -- Language `output` is not included in this bundle. ``` `hcl` doesn't error in Shiki, since it's a real grammar, but that's exactly the trap: it was silently rendering every fence with the generic HCL grammar instead of the Terraform-specific one. Every `hcl`-tagged fence in `docs/**` was manually checked against `origin/main` and is genuinely Terraform content. For `ts`/`tsx`, tokenizing the actual doc content confirmed identical output under both grammars; a synthetic test with the legacy angle-bracket cast syntax confirmed `tsx` degrades on that specific construct, which the style guide now calls out. The first normalization pass only matched fence tags at column 0 (`^```tag$`), missing tags indented inside numbered/bulleted lists. A follow-up pass caught the remaining occurrences at any indentation level. </details> --- *This PR description and the underlying changes were prepared with Coder Agents assistance.*
111 lines
4.4 KiB
Markdown
111 lines
4.4 KiB
Markdown
# Appearance
|
|
|
|
> [!NOTE]
|
|
> Customizing Coder's appearance is a Premium feature.
|
|
> [Learn more](https://coder.com/pricing#compare-plans).
|
|
|
|
Customize the look of your Coder deployment to meet your enterprise
|
|
requirements.
|
|
|
|
You can access the Appearance settings by navigating to
|
|
`Deployment > Appearance`.
|
|
|
|
|
|
|
|
## Application Name
|
|
|
|
Specify a custom application name to be displayed on the login page. The default
|
|
is Coder.
|
|
|
|
## Logo URL
|
|
|
|
Specify a custom URL for your enterprise's logo to be displayed on the sign in
|
|
page and in the top left corner of the dashboard. The default is the Coder logo.
|
|
|
|
## Announcement Banners
|
|
|
|
|
|
|
|
Announcement Banners let admins post important messages to all site users. Only
|
|
Site Owners may set the announcement banners.
|
|
|
|
Example: Use multiple announcement banners for concurrent deployment-wide
|
|
updates, such as maintenance or new feature rollout.
|
|
|
|
|
|
|
|
Example: Adhere to government network classification requirements and notify
|
|
users of which network their Coder deployment is on.
|
|
|
|
|
|
|
|
## OIDC Login Button Customization
|
|
|
|
[Use environment variables to customize](../users/oidc-auth/index.md#oidc-login-customization)
|
|
the text and icon on the OIDC button on the Sign In page.
|
|
|
|
## Support Links
|
|
|
|
Support links let admins adjust the user dropdown menu to include links
|
|
referring to internal company resources. The menu section replaces the original
|
|
menu positions: documentation, report a bug to GitHub, or join the Discord
|
|
server.
|
|
|
|
|
|
|
|
### Icons
|
|
|
|
The link icons are optional, and can be set to any url or
|
|
[builtin icon](../templates/extending-templates/icons.md#bundled-icons),
|
|
additionally `bug`, `chat`, `docs`, and `star` are available as special icons.
|
|
|
|
### Location
|
|
|
|
The `location` property is optional and determines where the support link will
|
|
be displayed:
|
|
|
|
- `navbar` - displays the link as a button in the top navigation bar
|
|
- `dropdown` - displays the link in the user dropdown menu (default)
|
|
|
|
If the `location` property is not specified, the link will be displayed in the
|
|
user dropdown menu.
|
|
|
|
### Configuration
|
|
|
|
#### Kubernetes
|
|
|
|
To configure support links in your Coder Kubernetes deployment, update your Helm
|
|
chart values as follows:
|
|
|
|
```yaml
|
|
coder:
|
|
env:
|
|
- name: CODER_SUPPORT_LINKS
|
|
value: >
|
|
[{"name": "Hello GitHub", "target": "https://github.com/coder/coder",
|
|
"icon": "bug"},
|
|
{"name": "Hello Slack", "target":
|
|
"https://codercom.slack.com/archives/C014JH42DBJ", "icon":
|
|
"/icon/slack.svg"},
|
|
{"name": "Hello Discord", "target": "https://discord.gg/coder", "icon":
|
|
"/icon/discord.svg", "location": "navbar"},
|
|
{"name": "Hello Foobar", "target": "https://foo.com/bar", "icon":
|
|
"/emojis/1f3e1.png"}]
|
|
```
|
|
|
|
#### System package
|
|
|
|
if running as a system service, set an environment variable
|
|
`CODER_SUPPORT_LINKS` in `/etc/coder.d/coder.env` as follows,
|
|
|
|
```dotenv
|
|
CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/discord.svg", "location": "navbar"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
|
|
```
|
|
|
|
For CLI, use,
|
|
|
|
```sh
|
|
export CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/discord.svg", "location": "navbar"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
|
|
coder-server
|
|
```
|