Browse Source

add data page on website

Help-14 3 years ago
parent
commit
e9358df0ca
2 changed files with 30 additions and 0 deletions
  1. 1 0
      docs/_sidebar.md
  2. 29 0
      docs/data.md

+ 1 - 0
docs/_sidebar.md

@@ -2,6 +2,7 @@
 
 * [Get Started](getting-started.md)
 * [Configuration](config.md)
+* [Data](data.md)
 * Customization
   * [Themes](customization/themes.md)
   * [Languages](customization/languages.md)

+ 29 - 0
docs/data.md

@@ -0,0 +1,29 @@
+# Bookmark data
+
+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                              |
+
+## GroupData
+| 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 | |
+
+## BookmarkData
+| Field   | Type   | Meaning                                             |
+| ------- | ------ | --------------------------------------------------- |
+| name | string | Bookmark name |
+| icon | string | Bookmark icon, can be fontawesome class or direct link |
+| url | string | Bookmark url |