docs(README.md): 更新项目说明

This commit is contained in:
JoeanAmier 2024-09-08 22:15:13 +08:00
parent ab405f605c
commit 99490d32f4
3 changed files with 4 additions and 40 deletions

View File

@ -65,7 +65,7 @@
<p>⭐ 推荐使用 <a href="https://learn.microsoft.com/zh-cn/windows/terminal/install">Windows 终端</a> Windows 11 默认终端)运行程序以便获得最佳显示效果!</p>
<h1>🥣 使用方法</h1>
<p>如果仅需下载无水印作品文件,建议选择 <b>程序运行</b><b>Docker 运行</b>;如果有其他需求,建议选择 <b>源码运行</b></p>
<p><del>建议自行设置 <code>cookie</code> 参数,若不设置该参数,程序功能可能无法正常使用!</del></p>
<p><code>2.2</code> 版本开始,项目功能无异常的情况下,无需额外处理 Cookie</p>
<h2>🖱 程序运行</h2>
<p>Mac OS、Windows 10 及以上用户可前往 <a href="https://github.com/JoeanAmier/XHS-Downloader/releases/latest">Releases</a> 下载程序压缩包,解压后打开程序文件夹,双击运行 <code>main</code> 即可使用。</p>
<p><strong>注意Mac OS 平台可执行文件 <code>main</code> 可能需要从终端命令行启动受设备限制Mac OS 平台可执行文件尚未经过测试,无法保证可用性!</strong></p>
@ -181,8 +181,6 @@ async def example():
work_path = "D:\\" # 作品数据/文件保存根路径,默认值:项目根路径
folder_name = "Download" # 作品文件储存文件夹名称自动创建默认值Download
name_format = "作品标题 作品描述"
# sec_ch_ua = "" # 请求头 Sec-Ch-Ua
# sec_ch_ua_platform = "" # 请求头 Sec-Ch-Ua-Platform
user_agent = "" # User-Agent
cookie = "" # 小红书网页版 Cookie无需登录可选参数登录状态对数据采集有影响
proxy = None # 网络代理
@ -198,8 +196,6 @@ async def example():
work_path=work_path,
folder_name=folder_name,
name_format=name_format,
# sec_ch_ua=sec_ch_ua,
# sec_ch_ua_platform=sec_ch_ua_platform,
user_agent=user_agent,
cookie=cookie,
proxy=proxy,
@ -256,18 +252,6 @@ async def example():
<td align="center"><code>发布时间 作者昵称 作品标题</code></td>
</tr>
<tr>
<td align="center"><del>sec_ch_ua</del>(已废弃)</td>
<td align="center">str</td>
<td align="center">浏览器请求头 Sec-Ch-Ua</td>
<td align="center">内置 Chrome Sec-Ch-Ua</td>
</tr>
<tr>
<td align="center"><del>sec_ch_ua_platform</del>(已废弃)</td>
<td align="center">str</td>
<td align="center">浏览器请求头 Sec-Ch-Ua-Platform</td>
<td align="center">内置 Chrome Sec-Ch-Ua-Platform</td>
</tr>
<tr>
<td align="center">user_agent</td>
<td align="center">str</td>
<td align="center">浏览器 User Agent</td>
@ -312,7 +296,7 @@ async def example():
<tr>
<td align="center">image_format</td>
<td align="center">str</td>
<td align="center">图文作品文件下载格式,支持:<code>PNG</code><code>WEBP</code></td>
<td align="center">图文作品文件下载格式,支持:<code>PNG</code><code>WEBP</code><br><strong>该参数影响下载图片时所用的接口,并非固定图片格式!</strong></td>
<td align="center">PNG</td>
</tr>
<tr>

View File

@ -66,7 +66,7 @@
<p>⭐ It is recommended to use the <a href="https://learn.microsoft.com/en-us/windows/terminal/install">Windows Terminal</a> (default terminal for Windows 11) to run the program for the best display effect!</p>
<h1>🥣 Usage</h1>
<p>If you only need to download watermark-free content files, it is recommended to choose <b>Program Run</b>; if you have other needs, it is recommended to choose <b>Source Code Run</b>!</p>
<p><del>It is recommended to set the <code>cookie</code> parameter manually; if this parameter is not set, the program functions may not work properly!</del></p>
<p>Starting from version <code>2.2</code>, if there are no abnormalities in project functionality, there is no need to handle cookies separately!</p>
<h2>🖱 Program Run</h2>
<p>Mac OS, Windows 10 and above users can go to <a href="https://github.com/JoeanAmier/XHS-Downloader/releases/latest">Releases</a> to download the program package, unzip it, open the program folder, and double-click to run <code>main</code> to use.</p>
<p><strong>Note: The executable file <code>main</code> for Mac OS may need to be launched from the terminal command line; Due to device limitations, the Mac OS executable file has not been tested and its availability cannot be guaranteed!</strong></p>
@ -185,8 +185,6 @@ async def example():
work_path = "D:\\" # 作品数据/文件保存根路径,默认值:项目根路径
folder_name = "Download" # 作品文件储存文件夹名称自动创建默认值Download
name_format = "作品标题 作品描述"
# sec_ch_ua = "" # 请求头 Sec-Ch-Ua
# sec_ch_ua_platform = "" # 请求头 Sec-Ch-Ua-Platform
user_agent = "" # User-Agent
cookie = "" # 小红书网页版 Cookie无需登录可选参数登录状态对数据采集有影响
proxy = None # 网络代理
@ -202,8 +200,6 @@ async def example():
work_path=work_path,
folder_name=folder_name,
name_format=name_format,
# sec_ch_ua=sec_ch_ua,
# sec_ch_ua_platform=sec_ch_ua_platform,
user_agent=user_agent,
cookie=cookie,
proxy=proxy,
@ -260,18 +256,6 @@ async def example():
<td align="center"><code>publish_time author_nickname title</code></td>
</tr>
<tr>
<td align="center"><del>sec_ch_ua</del>(Deprecated)</td>
<td align="center">str</td>
<td align="center">Browser request header Sec-Ch-Ua</td>
<td align="center">Built-in Chrome Sec-Ch-Ua</td>
</tr>
<tr>
<td align="center"><del>sec_ch_ua_platform</del>(Deprecated)</td>
<td align="center">str</td>
<td align="center">Browser request header Sec-Ch-Ua-Platform</td>
<td align="center">Built-in Chrome Sec-Ch-Ua-Platform</td>
</tr>
<tr>
<td align="center">user_agent</td>
<td align="center">str</td>
<td align="center">Browser User Agent</td>
@ -316,7 +300,7 @@ async def example():
<tr>
<td align="center">image_format</td>
<td align="center">str</td>
<td align="center">Download format for text and image content files, supported formats: <code>PNG</code>, <code>WEBP</code></td>
<td align="center">Download format for text and image content files, supported formats: <code>PNG</code>, <code>WEBP</code><br><strong>This parameter affects the API used when downloading images, not the fixed image format!</strong></td>
<td align="center">PNG</td>
</tr>
<tr>

View File

@ -19,8 +19,6 @@ async def example():
work_path = "D:\\" # 作品数据/文件保存根路径,默认值:项目根路径
folder_name = "Download" # 作品文件储存文件夹名称自动创建默认值Download
name_format = "作品标题 作品描述"
# sec_ch_ua = "" # 请求头 Sec-Ch-Ua
# sec_ch_ua_platform = "" # 请求头 Sec-Ch-Ua-Platform
user_agent = "" # User-Agent
cookie = "" # 小红书网页版 Cookie无需登录可选参数登录状态对数据采集有影响
proxy = None # 网络代理
@ -36,8 +34,6 @@ async def example():
work_path=work_path,
folder_name=folder_name,
name_format=name_format,
# sec_ch_ua=sec_ch_ua,
# sec_ch_ua_platform=sec_ch_ua_platform,
user_agent=user_agent,
cookie=cookie,
proxy=proxy,