浏览代码

Merge pull request #16 from claneys/patch-1

docs: add the isLocal flags description
Nhan Phan 2 年之前
父节点
当前提交
eda1d1bbec
共有 1 个文件被更改,包括 6 次插入5 次删除
  1. 6 5
      docs/data.md

+ 6 - 5
docs/data.md

@@ -26,8 +26,9 @@ Your bookmark data is in `/data/data.yaml`. You can take a look at sample file f
 
 ## 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                                                                           |
+| isLocal | boolean | Is this bookmark a local url that is not meant to be expose when accessed by internet. |