docs: 全局修改描述,在文档中加入版本信息并在发版时自动替换 (#128)

* 暂存

* chore: 修改一些杂项
This commit is contained in:
ᴀᴍᴛᴏᴀᴇʀ
2024-07-05 22:31:26 +08:00
committed by GitHub
parent fa2bc7b5e8
commit 352282f277
5 changed files with 18 additions and 16 deletions

View File

@@ -7,7 +7,7 @@ resolver = "2"
version = "2.0.7"
authors = ["amtoaer <amtoaer@gmail.com>"]
license = "MIT"
description = "基于 rust tokio 编写的 bilibili 收藏夹同步下载工具"
description = "由 Rust & Tokio 驱动的哔哩哔哩同步工具"
edition = "2021"
publish = false
@@ -62,9 +62,14 @@ tracing-subscriber = { version = "0.3.18", features = ["chrono"] }
[workspace.metadata.release]
release = false
tag-message = "chore: 发布 bili-sync 版本 {{version}}"
tag-message = ""
tag-prefix = ""
pre-release-commit-message = "chore: 发布 bili-sync {{version}}"
publish = false
pre-release-replacements = [
{ file = "../../docs/.vitepress/config.mts", search = "\"v[0-9\\.]+\"", replace = "\"v{{version}}\"", exactly = 1 },
{ file = "../../docs/introduction.md", search = " v[0-9\\.]+", replace = " v{{version}}", exactly = 1 },
]
[profile.release]
strip = true

View File

@@ -3,18 +3,12 @@
## 简介
> [!NOTE]
> 此为 v2.x 版本文档v1.x 版本文档请前往[此处](https://github.com/amtoaer/bili-sync/tree/v1.x)查看
为 NAS 用户编写的 BILIBILI 收藏夹同步工具,可使用 EMBY 等媒体库工具浏览。
支持展示视频封面、名称、加入日期、标签、分页等。
> [点击此处](https://bili-sync.allwens.work/)查看文档
bili-sync 是一款专为 NAS 用户编写的哔哩哔哩同步工具,由 Rust & Tokio 驱动。
## 效果演示
**注:因为可能同时存在单页视频和多页视频,媒体库类型请选择“混合内容”。**
### 概览
![概览](./assets/overview.png)
### 详情

View File

@@ -4,7 +4,7 @@ import taskLists from "markdown-it-task-lists";
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "bili-sync",
description: "基于 rust tokio 的哔哩哔哩同步工具",
description: "由 Rust & Tokio 驱动的哔哩哔哩同步工具",
lang: "zh-Hans",
sitemap: {
hostname: "https://bili-sync.github.io",
@@ -21,14 +21,14 @@ export default defineConfig({
nav: [
{ text: "主页", link: "/" },
{
text: "更新日志",
text: "v2.0.7",
items: [
{
text: "程序本体",
text: "程序更新",
link: "https://github.com/amtoaer/bili-sync/releases",
},
{
text: "文档页面",
text: "文档更新",
link: "https://github.com/search?q=repo:amtoaer/bili-sync+docs&type=commits",
},
],

View File

@@ -3,9 +3,9 @@
程序支持有限的命令行参数,可以通过执行 `bili-sync-rs --help` 查看说明。
```shell
bili-sync/target/debug docs_vitepress* ⇡
bili-sync/target/debug main* ⇡
./bili-sync-rs --help
基于 rust tokio 编写的 bilibili 收藏夹同步下载工具
由 Rust & Tokio 驱动的哔哩哔哩同步工具
Usage: bili-sync-rs [OPTIONS]

View File

@@ -1,5 +1,8 @@
# bili-sync 是什么?
> [!TIP]
> 当前最新程序版本为 v2.0.7,文档将始终与最新程序版本保持一致。
bili-sync 是一款专为 NAS 用户编写的哔哩哔哩同步工具。
它的基本的工作原理是使用用户填写的凭据定期扫描视频合集、收藏夹等,获取到本地未下载过的内容并保存到本地,维持本地视频库与哔哩哔哩网站的同步。