Skip to content

Commit a328593

Browse files
committed
docs: polish README usage and optional SingleFile section
1 parent 777fe86 commit a328593

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
### 安装
1111

12-
```
12+
```sh
1313
pip3 install .
1414
```
1515

@@ -18,7 +18,7 @@ pip3 install .
1818
需自行通过抓包获取 API 令牌(token)。部分开放节目(如《八分》)无须令牌。
1919

2020
执行以下命令运行:
21-
```
21+
```sh
2222
python3 -m vistopia.main --token [token] [subcommand]
2323
```
2424

@@ -29,17 +29,17 @@ python3 -m vistopia.main --token [token] [subcommand]
2929
- `save-show`: 保存节目至本地,并添加封面和 ID3 信息
3030
- `save-transcript`: 保存节目文稿至本地
3131

32-
### 使用 SingleFile 将文稿网页保存为纯本地文件
32+
#### 可选:使用 SingleFile 保存完整文稿网页
3333

3434
1. 下载 [SingleFile CLI](https://github.com/gildas-lormeau/single-file-cli/releases) 命令行程序
3535
2. 浏览器登陆网页版看理想,使用 cookie 导出工具(如:EditThisCookie)导出 json 格式的 cookies,并保存为本地文件
36-
3. 运行 `save-transcript` 命令,并传入 `--single-file-exec-path``--cookie-file-path` 参数
36+
3. 运行 `save-transcript` 命令,并传入 `--single-file-exec-path``--cookie-file-path` 参数(不传则按默认方式保存文稿)
3737

3838
命令格式:
39-
```
39+
```sh
4040
python3 -m vistopia.main --token [token] save-transcript --id [id] \
41-
--single-file-exec-path=/path/to/local/single-file \
42-
--cookie-file-path=/path/to/vistopia.cookie
41+
--single-file-exec-path=/path/to/local/single-file \
42+
--cookie-file-path=/path/to/vistopia.cookie
4343
```
4444

4545
## 不足
@@ -48,4 +48,4 @@ python3 -m vistopia.main --token [token] save-transcript --id [id] \
4848

4949
## 源代码开源授权
5050

51-
采用 [MIT 开源授权](./LICENCE)
51+
采用 [MIT 开源授权](./LICENSE)

0 commit comments

Comments
 (0)