metacubex / meta-docs

Meta-Docs

mihomo 的文档

使用方法

设置虚拟环境

部分操作系统python3.11以上依赖虚拟环境运行,不能直接运行

安装virtualenv

• debian

  • bash/zsh/fish

  apt update && apt install virtualenv

  • nushell

  apt update ; apt install virtualenv

• archlinux

  pacman -Syu python-virtualenv

创建虚拟环境

virtualenv venv

使用虚拟环境

• bash/zsh

source venv/bin/activate

• nushell

use venv/bin/activate.nu

• fish

source venv/bin/activate.fish

退出虚拟环境

deactivate

确认是否处于虚拟环境

which python3

设置源

pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple

安装依赖

pip install -r requirements.txt

预览修改

mkdocs serve

参考文档

https://squidfunk.github.io/mkdocs-material/setup/ https://squidfunk.github.io/mkdocs-material/reference/

推荐使用 Prettier 对文档进行格式化。

meta-docs's Issues

dns配置部分疑似书写错误

既"geosite:geolocation-!cn":
- "https://dns.cloudflare.com/dns-query#dns"
- "https://dns.google/dns-query#dns"部分
在官方配置手册中，表明“书写规范应带引号，以防出现特殊字符”，而在手册中，表明引号为'，不是“”
可是在“快捷配置”中，既"geosite:geolocation-!cn":
- "https://dns.cloudflare.com/dns-query#dns"
- "https://dns.google/dns-query#dns"
引用的是“”，并不是'这个单引号，与官方配置手册“书写规范应带引号，以防出现特殊字符”产生冲突，需要检查该部分内容是否出现错误？

希望可以添加一下对于负载均衡策略中sticky-sessions的说明

现在在文档里只有consistent-hashing 和 round-robin的，不知道sticky-sessions的运作方式是什么，搜了半天只有meta内核页面的一篇issue有涉及到，但是现在看不到meta内核页面的issue了

对Proxy Groups中hidden参数的处理

根据Clash Meta的Wiki

proxy-groups:
- name: "proxy"
  type: select
  proxies:
  - DIRECT
  - ss
  use:
  - provider1
  - provider1

  url: 'https://www.gstatic.com/generate_204'
  interval: 300
  lazy: true
  timeout: 5000

  disable-udp: true
  interface-name: en0
  routing-mark: 11451
  include-all: false
  include-all-proxies: false
  include-all-providers: false
  filter: "(?i)港|hk|hongkong|hong kong"
  exclude-filter: "美|日"
  exclude-type: "Shadowsocks|Http"
  expected-status: 204
  hidden: true
  icon: xxx

其中对hidden的说明如下：
hidden¶

Returns hidden status in the API to hide the display of this proxy-groups (requires front-end adaptation using the API).

目前MetaCube XD 似乎并不支持对hidden参数的处理，添加该参数后，面板仍然显示对应的Proxy Group

conf配置示例出错

conf配置示例出错，请调整格式

SRC-GEOIP示例写错了，将逗号写成了句号

路由规则的SRC-GEOIP示例写错了，将逗号写成了句号

- SRC-GEOIP,cn.DIRECT

对多用户模式的SS2022密码增加补充说明

从clash verge的使用来看，多用户模式的SS2022在填密码时需要同时填写服务端和客户端密码，两者用:连接。