magma/docs/data.md
Forlot Romain 686464932a
docs: add the isLocal flags description
This complete the feature added previously about masking local url link when startpage is accessed from the outside world aka internet :)
2022-10-13 21:50:38 +02:00

34 lines
1.8 KiB
Markdown

# 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 |
| isLocal | boolean | Is this bookmark a local url that is not meant to be expose when accessed by internet. |