https://github.com/metacubex/meta-docs

https://github.com/metacubex/meta-docs

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/metacubex/meta-docs
• Owner: MetaCubeX
• Created: 2023-04-10T10:01:55.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T19:21:26.000Z (about 2 years ago)
• Last Synced: 2024-04-12T20:37:06.572Z (about 2 years ago)
• Homepage: https://metacubex.github.io/Meta-Docs/
• Size: 1.86 MB
• Stars: 45
• Watchers: 2
• Forks: 62
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Meta-Docs

[mihomo](https://github.com/MetaCubeX/mihomo/tree/Alpha) 的文档

## 使用方法

### 设置虚拟环境

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

##### 安装virtualenv

* debian

  * bash/zsh/fish

  ```bash

  apt update && apt install virtualenv

  ```

  * nushell

  ```nushell

  apt update ; apt install virtualenv

  ```

* archlinux

  ```bash

  pacman -Syu python-virtualenv

  ```

##### 创建虚拟环境

```bash

virtualenv venv

```

##### 使用虚拟环境

* bash/zsh

```bash

source venv/bin/activate

```

* nushell

```nushell

use venv/bin/activate.nu

```

* fish

```bash

source venv/bin/activate.fish

```

##### 退出虚拟环境

```bash

deactivate

```

##### 确认是否处于虚拟环境

```bash

which python3

```

### 设置源

```bash

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

```

### 安装依赖

```bash

pip install -r requirements.txt

```

### 预览修改

```bash

mkdocs serve

```

### 参考文档

推荐使用 [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) 对文档进行格式化。