浏览代码

add features page to website

NhanPT 3 年之前
父节点
当前提交
f45d734860
共有 3 个文件被更改,包括 37 次插入19 次删除
  1. 2 1
      docs/_sidebar.md
  2. 22 18
      docs/data.md
  3. 13 0
      docs/features.md

+ 2 - 1
docs/_sidebar.md

@@ -1,6 +1,7 @@
 <!-- docs/_sidebar.md -->
 
-* [Get Started](getting-started.md)
+* [Features](features.md)
+* [Installation](getting-started.md)
 * [Configuration](config.md)
 * [Data](data.md)
 * Customization

+ 22 - 18
docs/data.md

@@ -3,27 +3,31 @@
 Your bookmark data is in `/data/data.yaml`. You can take a look at sample file for each theme in [sample folder](https://github.com/help-14/magma/tree/main/sample).
 
 ## data.yaml
-| Field   | Type   | Meaning                                             |
-| ------- | ------ | --------------------------------------------------- |
-| data | []GroupData | Your data goes here                              |
+
+| Field | Type        | Meaning             |
+| ----- | ----------- | ------------------- |
+| data  | []GroupData | Your data goes here |
 
 ## GroupData
-| Field   | Type   | Meaning                                             |
-| ------- | ------ | --------------------------------------------------- |
-| title | string | Group title |
-| icon | string | Group icon, can be fontawesome class or direct link |
-| columns | []ColumnData | |
+
+| Field   | Type         | Meaning                                             |
+| ------- | ------------ | --------------------------------------------------- |
+| title   | string       | Group title                                         |
+| icon    | string       | Group icon, can be fontawesome class or direct link |
+| columns | []ColumnData |                                                     |
 
 ## ColumnData
-| Field   | Type   | Meaning                                             |
-| ------- | ------ | --------------------------------------------------- |
-| title | string | Column title |
-| icon | string | Column icon, can be fontawesome class or direct link |
-| bookmarks | []BookmarkData | |
+
+| Field     | Type           | Meaning                                              |
+| --------- | -------------- | ---------------------------------------------------- |
+| title     | string         | Column title                                         |
+| icon      | string         | Column icon, can be fontawesome class or direct link |
+| bookmarks | []BookmarkData |                                                      |
 
 ## BookmarkData
-| Field   | Type   | Meaning                                             |
-| ------- | ------ | --------------------------------------------------- |
-| name | string | Bookmark name |
-| icon | string | Bookmark icon, can be fontawesome class or direct link |
-| url | string | Bookmark url |
+
+| Field | Type   | Meaning                                                |
+| ----- | ------ | ------------------------------------------------------ |
+| name  | string | Bookmark name                                          |
+| icon  | string | Bookmark icon, can be fontawesome class or direct link |
+| url   | string | Bookmark url                                           |

+ 13 - 0
docs/features.md

@@ -0,0 +1,13 @@
+# Magma features
+
+## Available
+- Multiple themes
+- Multiple languages
+- Current weather: using OpenWeatherMap API.
+- Reload on changes: Any changes to any file in data folder will trigger server reload.
+- Multiple icon format: you can use FontAwesome class as icon or any kind of image direct link (svg, png, jpg, gif, ...)
+
+## Work in progress
+- Docker intergration
+- New addons
+- New themes