更新文档 (#389)

Author: hect0x7

.github/ISSUE_TEMPLATE/ask-for-help.yml

@@ -14,11 +14,11 @@ body:
   - type: dropdown
     attributes:
       label: 你使用的是哪种方式？
+      multiple: true
       options:
         - GitHub Actions
         - Python代码
         - jmcomic命令行
-      default: 0
     validations:
       required: true
 
@@ -34,5 +34,8 @@ body:
 
   - type: textarea
     attributes:
-      label: 其他信息
-      placeholder: 如果有其他需要补充的信息，可以在这里留言
+      label: 额外信息（代码/option配置/截图等）
+      placeholder: |
+        - 如果是运行代码，请提供核心代码片段
+        - 如果有自定义option配置，请提供配置内容
+        - 如果是GitHub Actions，请提供运行记录的URL

.github/ISSUE_TEMPLATE/bug.yml

@@ -6,17 +6,19 @@ labels: [ 'bug' ]
 body:
   - type: checkboxes
     attributes:
-      label: 注意事项
+      label: 请确认注意事项
       options:
-        - label: 提ISSUE前，请确认你已经在GitHub Issues和Discussions里搜索过类似的问题，并且没找到想要的答案。
+        - label: 你已经在GitHub Issues和Discussions里搜索过类似的问题，并且没找到想要的答案。
           required: true
-        - label: GitHub Actions问题请到置顶的Issue反馈。
+        - label: 你使用的是最新的jmcomic版本
+          required: true
+        - label: 非GitHub Actions类问题（此类问题请专门到置顶的Issue反馈）
           required: true
 
   - type: dropdown
     attributes:
       label: 发生Bug时，你的使用方式？
-      multiple: false
+      multiple: true
       options:
         - Python代码
         - jmcomic命令行
@@ -26,7 +28,7 @@ body:
   - type: dropdown
     attributes:
       label: 你是否在禁漫官方网页或APP，验证过相应的功能是正常的？
-      multiple: false
+      multiple: true
       options:
         - 测试过，禁漫官方功能正常
         - 我要反馈的bug无需验证/不方便验证
@@ -35,18 +37,21 @@ body:
 
   - type: textarea
     attributes:
-      label: option配置+源码/命令
-      placeholder: 贴一下你的option配置 + 你使用的python代码或命令，这会帮助开发者解决bug。
+      label: 代码/option配置
+      placeholder: |
+        - 如果是运行代码，请提供核心代码片段
+        - 如果有自定义option配置，请提供配置内容
+        - 如果是GitHub Actions，请提供运行记录的URL
 
   - type: textarea
     attributes:
-      label: 你预期的结果，与实际结果的差别
+      label: 描述bug现象（你预期的结果，与实际结果的差别）
       placeholder: |
         1. 预期结果...
         2. 差别...
 
   - type: textarea
     attributes:
-      label: 其他信息
-      placeholder: 如果有其他需要补充的信息，可以在这里留言
+      label: 其他可提供的信息
+      placeholder: 截图/程序输出日志等
 

README.md

@@ -111,9 +111,9 @@ jmcomic 123 --option="D:/a.yml"
 
 b. 配置环境变量 `JM_OPTION_PATH` 为option文件路径（推荐）
 
+> 请自行google配置环境变量的方式，或使用powershell命令:  `setx JM_OPTION_PATH "D:/a.yml"` 重启后生效
+
 ```sh
-# setx JM_OPTION_PATH "D:/a.yml"
-# 重启终端生效
 jmcomic 123
 ```
 

assets/docs/sources/option_file_syntax.md

@@ -27,14 +27,17 @@ client:
   # APP端不限ip兼容性好，网页端限制ip地区但效率高
   impl: html
 
-  # domain: 域名配置，默认是 []，表示运行时自动获取域名。
-  # 可配置特定域名，如下：
-  # 程序会先用第一个域名，如果第一个域名重试n次失败，则换下一个域名重试，以此类推。
+  # domain: 禁漫域名配置，一般无需配置，jmcomic会根据上面的impl自动设置相应域名
+  # 该配置项需要和上面的impl结合使用，因为禁漫网页端和APP端使用的是不同域名，
+  # 所以配置是一个dict结构，key是impl的值，value是域名列表，表示这个impl走这些域名。
+  # 域名列表的使用顺序是：先用第一个域名，如果第一个域名重试n次失败，则换下一个域名重试，以此类推。
+  # 下面是示例：（注意下面这些域名可能会过时，不一定能用）
   domain:
-    - jm-comic.org
-    - jm-comic2.cc
-    - 18comic.vip
-    - 18comic.org
+    html:
+      - 18comic.vip
+      - 18comic.org
+    api:
+      - www.jmapiproxyxxx.vip
 
   # retry_times: 请求失败重试次数，默认为5
   retry_times: 5

assets/docs/sources/tutorial/0_common_usage.md

@@ -63,7 +63,7 @@ def fetch(photo: JmPhotoDetail):
     # 下载单个图片
     client.download_by_image_detail(image, './a.jpg')
     # 如果是已知未混淆的图片，也可以直接使用url来下载
-    random_image_domain = JmModuleConfig.DOMAIN_IMAGE_LIST
+    random_image_domain = JmModuleConfig.DOMAIN_IMAGE_LIST[0]
     client.download_image(f'https://{random_image_domain}/media/albums/416130.jpg', './a.jpg')
 
 

assets/docs/sources/tutorial/2_command_line.md

@@ -12,14 +12,15 @@ jmcomic 123 456 p333
 ### 2.1. 通过命令行
 使用 --option 参数指定option配置文件路径
 
-```
+```sh
 jmcomic 123 --option="D:/a.yml"
 ```
 
 ### 2.2. 使用环境变量
 配置环境变量 `JM_OPTION_PATH` 为option配置文件路径
 
-```
-set JM_OPTION_PATH="D:/a.yml"
+> 请自行google配置环境变量的方式，或使用powershell命令:  `setx JM_OPTION_PATH "D:/a.yml"` 重启后生效
+
+```sh
 jmcomic 123
 ```