From 57a9398f7869f169d19af4bef97f7cc06a63f92a Mon Sep 17 00:00:00 2001 From: Elihuso Quigley Date: Fri, 17 May 2024 21:11:22 +0800 Subject: [PATCH] [D] Banner --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index c2f6400c..c77732e8 100644 --- a/README.md +++ b/README.md @@ -70,3 +70,22 @@ We are trying to rewrite the multilingual architecture of the website to make it ``` If you don’t understand how to modify it, please feel free to [Contact Us](https://one-among.us/about/). + +## Banner and other tagged data + +Markup data such as banner can be used in documents. The format is as follows: + +`[[ {/*JSON*/} ]]` + +The internal JSON schema is as follows: + +* `type`: The type of tagged data, can be `banner` +* `icon`: The url of the icon. svg cannot be used. +* `title`: Title of item. +* `text`: Text of item. + +### Example + +```json +[[ {"type":"banner", "icon":"https://data.one-among.us/people/shi_Yumiaoya/photos/profile.jpg","title":"Some content of this entry doesn’t correspond to fact","text":"You are probably keeping track of an ongoing event, if you feel uncomfortable or stressed, we suggest that you pause browsing the relevant topics."} ]] +```