fix: rule sets in api document

7Sageer · Aug 15, 2024 · d31bd95 · d31bd95
1 parent 000e5eb
commit d31bd95
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 36 deletions.
diff --git a/doc/API-doc-en.md b/doc/API-doc-en.md
@@ -87,24 +87,26 @@ These can be used in the `selectedRules` parameter for Sing-Box and Clash config
 
 Instead of using predefined rule sets, you can provide a custom list of rules as a JSON array in the `selectedRules` parameter. Available rules include:
 
-- Ad Block (site-rule:category-ads-all) 
-- AI Services (site-rule:openai,anthropic,jetbrains-ai)
-- Bilibili (site-rule:bilibili)
-- Youtube (site-rule:youtube)
-- Google (site-rule:google)
-- Private (site-rule:private)
-- Location:CN (ip-rule:cn), (site-rule:geolocation-cn)
-- Telegram (ip-rule:telegram)
-- Microsoft (site-rule:microsoft)
-- Apple (site-rule:apple)
-- Bahamut (site-rule:bahamut)
-- Social Media (site-rule:facebook, instagram, twitter, tiktok, linkedin)
-- Streaming (site-rule:netflix, hulu, disney, hbo, amazon)
-- Gaming (site-rule:steam, epicgames, ea, ubisoft, blizzard)
-- Github (site-rule:github, gitlab)
-- Education (site-rule:coursera, edx, udemy, khanacademy)
-- Financial (site-rule:paypal, visa, mastercard)
-- Cloud Services (site-rule:aws, azure, digitalocean, heroku, dropbox)
+| Rule Name | Used Site Rules | Used IP Rules |
+|---|---|---|
+| Ad Block | category-ads-all |  |
+| AI Services | openai,anthropic,jetbrains-ai |  |
+| Bilibili | bilibili |  |
+| Youtube | youtube |  |
+| Google | google | google |
+| Private |  | private |
+| Location:CN | geolocation-cn | cn |
+| Telegram |  | telegram |
+| Microsoft | microsoft |  |
+| Apple | apple |  |
+| Bahamut | bahamut |  |
+| Social Media | facebook, instagram, twitter, tiktok, linkedin |  |
+| Streaming | netflix, hulu, disney, hbo, amazon |  |
+| Gaming | steam, epicgames, ea, ubisoft, blizzard |  |
+| Github | github, gitlab |  |
+| Education | coursera, edx, udemy, khanacademy |  |
+| Financial | paypal, visa, mastercard |  |
+| Cloud Services | aws, azure, digitalocean, heroku, dropbox |  |
 
 ## Error Handling
 

diff --git a/doc/API-doc.md b/doc/API-doc.md
@@ -87,24 +87,26 @@ API 支持以下预定义规则集:
 
 除了使用预定义规则集,您还可以在 `selectedRules` 参数中提供自定义规则列表作为 JSON 数组。可用规则包括:
 
-- Ad Block (site-rule:category-ads-all)
-- AI Services (site-rule:openai,anthropic,jetbrains-ai)
-- Bilibili (site-rule:bilibili)
-- Youtube (site-rule:youtube)
-- Google (site-rule:google)
-- Private (site-rule:private)
-- Location:CN (ip-rule:cn), (site-rule:geolocation-cn)
-- Telegram (ip-rule:telegram)
-- Microsoft (site-rule:microsoft)
-- Apple (site-rule:apple)
-- Bahamut (site-rule:bahamut)
-- Social Media (site-rule:facebook, instagram, twitter, tiktok, linkedin)
-- Streaming (site-rule:netflix, hulu, disney, hbo, amazon)
-- Gaming (site-rule:steam, epicgames, ea, ubisoft, blizzard)
-- Github (site-rule:github, gitlab)
-- Education (site-rule:coursera, edx, udemy, khanacademy)
-- Financial (site-rule:paypal, visa, mastercard)
-- Cloud Services (site-rule:aws, azure, digitalocean, heroku, dropbox)
+| Rule Name | Used Site Rules | Used IP Rules |
+|---|---|---|
+| Ad Block | category-ads-all |  |
+| AI Services | openai,anthropic,jetbrains-ai |  |
+| Bilibili | bilibili |  |
+| Youtube | youtube |  |
+| Google | google | google |
+| Private |  | private |
+| Location:CN | geolocation-cn | cn |
+| Telegram |  | telegram |
+| Microsoft | microsoft |  |
+| Apple | apple |  |
+| Bahamut | bahamut |  |
+| Social Media | facebook, instagram, twitter, tiktok, linkedin |  |
+| Streaming | netflix, hulu, disney, hbo, amazon |  |
+| Gaming | steam, epicgames, ea, ubisoft, blizzard |  |
+| Github | github, gitlab |  |
+| Education | coursera, edx, udemy, khanacademy |  |
+| Financial | paypal, visa, mastercard |  |
+| Cloud Services | aws, azure, digitalocean, heroku, dropbox |  |
 
 ## 错误处理