瀏覽代碼

update website layout

NhanPT 3 年之前
父節點
當前提交
c54de6df56
共有 3 個文件被更改,包括 22 次插入11 次删除
  1. 18 10
      docs/config.md
  2. 2 0
      docs/customization/themes.md
  3. 2 1
      docs/index.html

+ 18 - 10
docs/config.md

@@ -1,6 +1,6 @@
 # Configuration
 # Configuration
 
 
-Your configuration is in `/data/config.yaml` like this:
+Your configuration is in `/data/config.yaml` and should look like this:
 
 
 ```
 ```
 website:
 website:
@@ -20,15 +20,23 @@ addons:
 | Field   | Type   | Meaning                                             |
 | Field   | Type   | Meaning                                             |
 | ------- | ------ | --------------------------------------------------- |
 | ------- | ------ | --------------------------------------------------- |
 | website | Object | Website configuration                               |
 | 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="" />` |
 | 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 - 0
docs/customization/themes.md

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

+ 2 - 1
docs/index.html

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