Skip to content

Commit

Permalink
Merge pull request #14 from PBH-BTN:english
Browse files Browse the repository at this point in the history
english docs init
  • Loading branch information
Gaojianli authored Nov 12, 2024
2 parents 62137fa + deeaf9b commit d05c5f6
Show file tree
Hide file tree
Showing 116 changed files with 2,778 additions and 144 deletions.
2 changes: 1 addition & 1 deletion docs/setup/Linux/Deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ OpenJDK 64-Bit Server VM (build xxxxxxx, mixed mode, sharing)
```

## 下载安装
访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest),向下滚动,下载 DEB 文件。
访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest) 下载 DEB 文件。

安装 DEB 文件:

Expand Down
5 changes: 3 additions & 2 deletions docs/setup/Linux/LinuxInstall4j.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ sidebar_label: 安装程序(不推荐)


# 安装程序

> 请注意:我们更推荐您使用 [Docker部署](../Docker.md)
:::tip
请注意:这将破坏系统的[FHS](https://zh.wikipedia.org/wiki/%E6%96%87%E4%BB%B6%E7%B3%BB%E7%BB%9F%E5%B1%82%E6%AC%A1%E7%BB%93%E6%9E%84%E6%A0%87%E5%87%86)兼容性,我们更推荐您使用 [Docker部署](../Docker.md)
:::

Redhat 系用户请前往 [Releases](https://github.com/PBH-BTN/PeerBanHelper/releases)下载`.rpm`软件包,对于其他 Linux 用户请 下载以 `.sh` 结尾的安装程序。

Expand Down
6 changes: 3 additions & 3 deletions docs/setup/Linux/Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ sidebar_position: 2


# 手动部署

:::tip
请注意:我们更推荐您使用 [Docker部署](../Docker.md))

:::
## 安装依赖

使用你的包管理器安装 OpenJDK 21 或更高版本(此处以 apt 为例):
Expand All @@ -31,7 +31,7 @@ OpenJDK 64-Bit Server VM (build xxxxxxx, mixed mode, sharing)
```

## 下载JAR
访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)向下滚动,下载 JAR 文件和 libraries.tar.gz。
访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest),下载 JAR 文件和 libraries.tar.gz。

将解压出来的 libraries 文件夹和 jar 放在一起。

Expand Down
2 changes: 1 addition & 1 deletion docs/setup/Synology DSM/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ sidebar_position: 6

## 获取版本标签

首先访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest)向下滚动,找到如图所示的 “Docker 用户” 章节,并复制镜像标签备用。
首先访问 [PBH最新版版本发布页](https://github.com/PBH-BTN/PeerBanHelper/releases/latest),找到如图所示的 “Docker 用户” 章节,并复制镜像标签备用。

![image-tag](../assets/docker-tag.png)

Expand Down
7 changes: 6 additions & 1 deletion docs/setup/Windows/Portable.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ sidebar_position: 2

## 升级

:::warning
你必须重新解压所有的文件,**不可以覆盖!**必须重新解压所有内容!**
:::


要升级 Portable 包,首先将 `data` 数据文件夹挪出工作目录到其他位置。删除原来的文件夹并重新解压新版本的 Portable 包,并将 `data` 数据文件夹挪回原来的位置即可。

**特别注意:你必须重新解压所有的文件,不可以覆盖!不可以覆盖!不可以覆盖!不可以覆盖!不可以覆盖!不可以覆盖!不可以覆盖!必须重新解压所有内容!**

4 changes: 2 additions & 2 deletions docs/setup/macOS/Installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ sidebar_position: 1

### GUI

顾名思义,以图形窗口启动 PeerBanHelper。会有一个窗口可以查看日志,以及一个可以打开数据文件夹和免登录打开 WebUI 的菜单。
以图形窗口启动 PeerBanHelper。会有一个窗口可以查看日志,以及一个可以打开数据文件夹和免登录打开 WebUI 的菜单。
点击窗口的关闭按钮,就可以最小化到系统托盘图标。

### GUI Silent
Expand All @@ -29,4 +29,4 @@ sidebar_position: 1

### NoGUI

以控制台的模式情况,最节约资源。适合硬核用户。
以控制台的模式情况,最节约资源。
100 changes: 51 additions & 49 deletions docusaurus-cf-pages.config.ts
Original file line number Diff line number Diff line change
@@ -1,130 +1,132 @@
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import type * as Preset from "@docusaurus/preset-classic";
import type { Config } from "@docusaurus/types";
import { themes as prismThemes } from "prism-react-renderer";

const config: Config = {
title: 'PeerBanHelper',
tagline: '自动封禁不受欢迎、吸血和异常的 BT 客户端,并支持自定义规则',
favicon: 'img/favicon.ico',
title: "PeerBanHelper",
tagline: "自动封禁不受欢迎、吸血和异常的 BT 客户端,并支持自定义规则",
favicon: "img/favicon.ico",

// Set the production url of your site here
url: 'https://pbh-btn.github.io',
url: "https://pbh-btn.github.io",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',
baseUrl: "/",

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'PBH-BTN', // Usually your GitHub org/user name.
projectName: 'pbh-docs', // Usually your repo name.
organizationName: "PBH-BTN", // Usually your GitHub org/user name.
projectName: "pbh-docs", // Usually your repo name.

onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",

// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'zh-Hans',
defaultLocale: "zh-Hans",
//locales: ['en', 'zh-Hans'],
locales: ['zh-Hans'],
locales: ["en", "zh-Hans"],
},


themes: [
// ... Your other themes.
[
require.resolve("@easyops-cn/docusaurus-search-local"),
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
({
{
// ... Your options.
// `hashed` is recommended as long-term-cache of index file is possible.
hashed: true,
// For Docs using Chinese, The `language` is recommended to set to:
// ```
language: ["en", "zh"],
// ```
}),
},
],
],

presets: [
[
'classic',
"classic",
{
docs: {
sidebarPath: './sidebars.ts',
sidebarPath: "./sidebars.ts",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/PBH-BTN/pbh-docs/edit/master',
editUrl: "https://github.com/PBH-BTN/pbh-docs/edit/master",
},
theme: {
customCss: './src/css/custom.css',
customCss: "./src/css/custom.css",
},
} satisfies Preset.Options,
],
],

themeConfig: {
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
image: "img/docusaurus-social-card.jpg",
navbar: {
title: 'PeerBanHelper',
title: "PeerBanHelper",
logo: {
alt: 'My Site Logo',
src: 'img/logo.svg',
alt: "My Site Logo",
src: "img/logo.svg",
},
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: '文档',
type: "docSidebar",
sidebarId: "tutorialSidebar",
position: "left",
label: "文档",
},
{
href: 'https://github.com/PBH-BTN/pbh-docs',
label: 'GitHub',
position: 'right',
href: "https://github.com/PBH-BTN/pbh-docs",
label: "GitHub",
position: "right",
},
{
type: 'localeDropdown',
position: 'right',
type: "localeDropdown",
position: "right",
},
],
},
footer: {
style: 'dark',
style: "dark",
links: [
{
title: '文档',
title: "文档",
items: [
{
label: 'PeerBanHelper',
to: '/docs/intro',
label: "PeerBanHelper",
to: "/docs/intro",
},
],
},
{
title: '社区',
title: "社区",
items: [
{
label: 'GitHub',
href: 'https://github.com/PBH-BTN/PeerBanHelper',
label: "GitHub",
href: "https://github.com/PBH-BTN/PeerBanHelper",
},
{
label: "QQ 群",
href: "https://qm.qq.com/cgi-bin/qm/qr?k=w5as_wH2G1ReUrClreCYhR69XiNCuP65&jump_from=webapi&authKey=EyjMX7Pwc77XLM51V6FEcR7oXnG8fsUbSFqYZ4PPiEpq32vBglJn/jFvpc3LFDhn",
},
{
label: 'QQ 群',
href: 'https://qm.qq.com/cgi-bin/qm/qr?k=w5as_wH2G1ReUrClreCYhR69XiNCuP65&jump_from=webapi&authKey=EyjMX7Pwc77XLM51V6FEcR7oXnG8fsUbSFqYZ4PPiEpq32vBglJn/jFvpc3LFDhn',
}
label: "Telegram",
href: "https://t.me/+_t3Nt5GZ6bJmYjBl",
},
],
},
{
title: '支持我们',
title: "支持我们",
items: [
{
label: '爱发电',
to: 'https://afdian.com/a/Ghost_chu',
}
label: "爱发电",
to: "https://afdian.com/a/Ghost_chu",
},
],
},
],
Expand Down
Loading

0 comments on commit d05c5f6

Please sign in to comment.