Skip to content

Commit c89b916

Browse files
authored
README、文档优化 (#239)
1 parent ac33f4d commit c89b916

File tree

2 files changed

+33
-9
lines changed

2 files changed

+33
-9
lines changed

README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,50 @@
4343

4444
## 快速上手
4545

46-
使用下面的两行代码,即可实现功能:把某个本子(album)里的所有章节(photo)下载到本地
47-
46+
### 1. 下载本子方法
47+
只需要使用如下代码,就可以下载本子`JM422866`的所有章节的图片:
4848
```python
4949
import jmcomic # 导入此模块,需要先安装.
5050
jmcomic.download_album('422866') # 传入要下载的album的id,即可下载整个album到本地.
5151
```
5252

53-
* v2.2.9: 新增命令行调用方式,上述的代码可以转为一行命令
53+
上面的 `download_album`方法还有一个参数`option`,可用于控制下载配置,配置包括禁漫域名、网络代理、图片格式转换、插件等等。
54+
55+
你可能需要这些配置项。推荐使用配置文件创建option,用option下载本子,见下章:
56+
57+
### 2. 使用option配置来下载本子
58+
59+
1. 首先,创建一个配置文件,假设文件名为 `option.yml`
60+
61+
该文件有特定的写法,你需要参考这个文档 → [option配置](./assets/docs/sources/option_file_syntax.md)
62+
63+
下面做一个演示,假设你需要把下载的图片转为png格式,你应该把以下内容写进`option.yml`
64+
65+
```yml
66+
download:
67+
image:
68+
suffix: .png # 该配置用于把下载的图片转为png格式
69+
```
70+
71+
2. 第二步,运行下面的python代码
72+
```python
73+
import jmcomic
5474

55-
```bash
56-
# 下载album_id为422866的本子
57-
$ jmcomic 422866
75+
# 创建配置对象
76+
option = jmcomic.create_option_by_file('你的配置文件路径,例如 D:/option.yml')
77+
# 使用option对象来下载本子
78+
jmcomic.download_album(422866, option)
5879
```
5980

81+
82+
6083
## 进阶使用
6184

6285
文档网站:[jmcomic.readthedocs.io](https://jmcomic.readthedocs.io/en/latest)
6386

64-
进阶使用可以参考:[jmcomic常用类和方法演示](assets/docs/sources/tutorial/0_demo.md)
87+
首先,就下载功能,jmcomic提供了很多配置项,大部分的下载需求你都可以通过上文介绍的配置文件来配置。
6588

66-
下面列出的是一些常用的文档
89+
如果你不满足于下载,还有其他的使用需求,推荐你先看看以下文档
6790

6891
* [jmcomic常用类和方法演示](assets/docs/sources/tutorial/0_demo.md)
6992
* [option配置文件语法(包含插件配置)](./assets/docs/sources/option_file_syntax.md)

assets/docs/sources/option_file_syntax.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ client:
2626
# 可配置:
2727
# html - 表示网页端
2828
# api - 表示APP端
29+
# APP端不限ip兼容性好,网页端限制ip地区但效率高
2930
impl: html
3031

3132
# domain: 域名配置,默认是 [],表示运行时自动获取域名。
@@ -42,7 +43,7 @@ client:
4243

4344
# postman: 请求配置
4445
postman:
45-
metadata:
46+
meta_data:
4647
# proxies: 代理配置,默认是 system,表示使用系统代理。
4748
# 以下的写法都可以:
4849
# proxies: null # 不使用代理

0 commit comments

Comments
 (0)