mirror of
https://github.com/checktheroads/hyperglass
synced 2024-05-11 05:55:08 +00:00
47 lines
1.1 KiB
Plaintext
47 lines
1.1 KiB
Plaintext
---
|
|
title: Configuration Options
|
|
description: Customize hyperglass to fit your needs.
|
|
---
|
|
|
|
import { Callout } from 'nextra-theme-docs';
|
|
|
|
Once you've gotten started with a basic configuration, you'll probably want to customize the look and feel of hyperglass by changing the logo or color scheme. Fortunately, there are _a lot_ ways to customize hyperglass.
|
|
|
|
## Configuration File
|
|
|
|
Create a file called `config.yaml` in `/etc/hyperglass`.
|
|
|
|
<Callout type="info">
|
|
**File Extensions** <br />
|
|
All the examples in the docs are provided in [YAML](https://yaml.org/) format, but [TOML](https://toml.io/)
|
|
and JSON are also supported.
|
|
</Callout>
|
|
|
|
### Common Examples
|
|
|
|
#### Change the title and organization name
|
|
|
|
```yaml filename="config.yaml"
|
|
site_title: Our super neat looking glass
|
|
org_name: Cool Company
|
|
```
|
|
|
|
#### Change the logo
|
|
|
|
```yaml filename="config.yaml"
|
|
web:
|
|
logo:
|
|
light: <path to logo image file to use in light mode>
|
|
dark: <path to logo image file to use in dark mode>
|
|
```
|
|
|
|
#### Change the color scheme
|
|
|
|
```yaml filename="config.yaml"
|
|
web:
|
|
theme:
|
|
colors:
|
|
primary: '#d84b4b'
|
|
secondary: '#118ab2'
|
|
```
|