Skip to content

docs: document new configuration features #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
denis-kudelin merged 2 commits into from
Aug 18, 2025
Merged

docs: document new configuration features #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d096ff
docs: document new config features
denis-kudelin Aug 18, 2025
9d7d14b
docs: add stash bullet
denis-kudelin Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README-cn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1444,3 +1444,12 @@ http://127.0.0.1:25500/getruleset?type=%TYPE%&url=%URL%&group=%GROUP%
| group | type=2时必选 | mygroup | 规则对应的策略组名，生成Quantumult X类型（type=2）时必须提供 |

运行 subconverter 主程序后， 按照 [调用地址 (规则转换)](#调用地址-规则转换) 的对应内容替换即可得到指定类型的规则。

## 其他特性

- 支持 Stash 作为源和目标格式。
- `managed_config_url` 可设定托管配置的完整链接。
- `embed_remote_rules` 启用后会将远程规则直接嵌入输出。
- 规则集链接支持 `,flags=` 参数以附加 Surge 风格标志。
- 支持 `DOMAIN-WILDCARD` 规则类型，在 Clash 与 Sing-box 中会转换为 `DOMAIN-REGEX`。
- 外部配置文件可在 `general` 段中覆盖 Surge 的 `[General]` 设置。
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,12 @@ Example:
;uncomment the following line and enter your token to enable upload function
token = xxxxxxxxxxxxxxxxxxxxxxxx(Your Personal Access Token)
```

## Additional Features

- Stash is available as both a source and target format.
- `managed_config_url` specifies the full link used for managed configuration headers.
- `embed_remote_rules` embeds remote ruleset contents directly into the generated profile.
- Rule URLs accept an optional `,flags=` parameter for Surge style rule-set flags.
- The rule converter recognises `DOMAIN-WILDCARD` entries and converts them to `DOMAIN-REGEX` for Clash and Sing-box.
- External configurations can include a `general` section to override Surge `[General]` options.
Loading