README.md

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 对文档进行格式化。