add features page to website

This commit is contained in:
NhanPT 2022-05-13 21:57:21 +07:00
parent c54de6df56
commit f45d734860
3 changed files with 37 additions and 19 deletions

View file

@ -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

View file

@ -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
docs/features.md Normal file
View file

@ -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