0ct0pu5/magma
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update website layout

Browse source
This commit is contained in:
NhanPT 2022-05-13 21:45:06 +07:00
parent c468d06020
commit c54de6df56
3 changed files with 22 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/config.md
View file

@ -1,6 +1,6 @@
# Configuration
Your configuration is in `/data/config.yaml` like this:
Your configuration is in `/data/config.yaml` and should look like this:
```
website:
@ -20,15 +20,23 @@ addons:
| Field | Type | Meaning |
| ------- | ------ | --------------------------------------------------- |
| website | Object | Website configuration |
| addons | Array | List of addon to run. E.g: `["addon-1", "addon-2"]` |
| openweathermap | Object | Weather configuration |
| addons | Array | List of addons to run. E.g: `docker, health-check-server, ...` |
Website configuration:
## Website configuration:
| Field | Type | Meaning |
| ------------ | ------- | ----------------------------------------------------------------------------------------- |
| theme | string | Name of your selected theme, default is `flame` |
| title | string | Title of your website, will be inject into `<title></title>` |
| Field | Type | Meaning |
| ------------ | ------- | - |
| theme | string | Name of your selected theme, default is `flame` |
| title | string | Title of your website, will be inject into `<title></title>` |
| description | string | Description of your website, will be inject into `<meta name="description" content="" />` |
| language | string | Selected language file in `/languages` without `.yaml` extension. |
| localization | string | Localization that will be use to show date/time |
| useMetric | boolean | Set to `true` to use `°C`, `false` to use `°F` |
| language | string | Selected language file in `/languages` without `.yaml` extension. |
| localization | string | Localization that will be use to show date/time |
| useMetric | boolean | Set to `true` to use `°C`, `false` to use `°F` |
## Weather configuration
| Field | Type | Meaning |
| ------------ | ------- | - |
| apiKey | string | API key from [OpenWeatherMap](https://openweathermap.org/current). You'll need to create an account to get one. |
| lon | string | Longitude of your [current address](https://www.gps-latitude-longitude.com/gps-coordinates-of-mine) |
| lat | string | Latitude of your [current address](https://www.gps-latitude-longitude.com/gps-coordinates-of-mine) |

2
docs/customization/themes.md
View file

@ -1,3 +1,5 @@
# Available themes
## flame
![Flame theme](../screenshots/flame.png)

3
docs/index.html
View file

@ -18,6 +18,7 @@
repo: 'help-14/magma',
loadSidebar: true,
subMaxLevel: 1,
homepage: 'customization/themes.md',
alias: {
'/.*/_sidebar.md': '/_sidebar.md'
},
@ -28,4 +29,4 @@
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
</body>
</html>
</html>