diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..bdb1f69ed --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,32 @@ +name: Deploy Vuepress +on: + push: + branches: + - main +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + - name: Get yarn cache directory path + id: yarn-cache-dir-path + run: echo "::set-output name=dir::$(yarn cache dir)" + - uses: actions/cache@v2 + id: yarn-cache + with: + path: ${{ steps.yarn-cache-dir-path.outputs.dir }} + key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} + restore-keys: | + ${{ runner.os }}-yarn- + - name: Install and Build + run: | + yarn install + yarn docs:build + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/.vuepress/dist diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 3fc16bba2..a5270cb9c 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -2,6 +2,7 @@ module.exports = { plugins: [ '@vuepress/back-to-top' ], + base: '/Xray-docs-next/', locales: { '/': { lang: 'zh-CN', @@ -38,4 +39,4 @@ module.exports = { includeLevel: [2] } } -} \ No newline at end of file +} diff --git a/docs/about/news.md b/docs/about/news.md index c93b8d46b..69a8c76fd 100644 --- a/docs/about/news.md +++ b/docs/about/news.md @@ -7,6 +7,44 @@ sidebar: auto # 大史记 +## 2021.3.14 + +### [v1.4.0](https://github.com/XTLS/Xray-core/releases/tag/v1.4.0) + +- Happy Pi-Day! +- 这次是个大更新: + - 为链式代理引入了传输层支持。 + - 为 Dialer 引入了 Domain Strategy,解决奇妙的 DNS 问题。 + - 添加了 gRPC 传输方式,与更快一点的 Multi Mode。 + - 添加了 WebSocket Early-Data 功能,减少了 WebSocket 的延迟。 + - 添加了 FakeDNS。 + - 还修复了系列的问题,添加了各类功能,详情请见更新日志。 +- 还是 VuePress 比较爽啊( + +## 2021.3.3 + +### [v1.3.1](https://github.com/XTLS/Xray-core/releases/tag/v1.3.1) + +- 这个版本使用了 Golang 1.16,正式原生支持 Apple Silicon。 +- 同时修复了一个会导致 Panic 的 bug。~~Holmium_认为这是在骗、在偷袭。~~ +- 修复了几个遗留问题。 + +## 2021.2.14 + +### [v1.3.0](https://github.com/XTLS/Xray-core/releases/tag/v1.3.0) + +- Happy 🐮 Year 🎉! +- v1.3.0 通过非常巧妙的机制实现了 V 系协议全部 FullCone,同时保证了一定的兼容性。 +- OHHHHHHHHHHHH! + +## 2021.01.31 + +### [v1.2.4](https://github.com/XTLS/Xray-core/releases/tag/v1.2.4) +- 解决两个“连接至标准 Socks 服务端时可能出错”的历史遗留问题。 +- 似乎这个版本没有什么改变,但这只是暴风雨前的宁静。 +- (没错我就是先知) +> 你个傻子,你拿的是 UNO 牌。 + ## 2021.01.25 - 全互联网最好最详细的秘籍入门篇同学们练熟了吗? 🍉老师开始连载[秘籍第一层](../../documents/level-1/)咯... - [英文版文档网站](/en)逐渐增加内容ing, 感谢各位大佬的辛苦付出~! @@ -207,4 +245,4 @@ Xray的第一个版本. project X start -> ~~梦开始的时候~~ \ No newline at end of file +> ~~梦开始的时候~~ diff --git a/docs/development/build.md b/docs/development/build.md index be6e19f37..b07905ef5 100644 --- a/docs/development/build.md +++ b/docs/development/build.md @@ -60,7 +60,7 @@ $env:GOARCH="amd64" go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main ``` -上传到服务器后,记得在服务器终端内执行 chmod +x v2ray 和 chmod +x v2ctl +上传到服务器后,记得在服务器终端内执行 `chmod +x xray` ::: tip 执行 `go tool dist list` 查看所有支持的系统与架构。 @@ -68,8 +68,8 @@ go build -o xray -trimpath -ldflags "-s -w -buildid=" ./main ## 可复现构建: -按照上述步骤,能够编译出与 Release 中相同的二进制文件。 +按照上述步骤,能够编译出与 Release 中完全相同的二进制文件。 ::: warning -请先确认您使用的 Golang 与编译 Release 一致。 +请先确认您使用的 Golang 版本与编译 Release 的一致。 ::: diff --git a/docs/guide/README.md b/docs/guide/README.md index 24fddbb66..f33925d5d 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -22,8 +22,8 @@ Xray有多种命令和参数可用,因此变得灵活和强大. 请点击[Xray的命令参数](./command)查看Xray的更多命令和参数用法. -## 使用文档 +## 改进文档 -您正在查看的是 Project X 的文档网站. 您可以了解更多网站的使用方式, 或是帮助我们改进文档质量. +如果你有兴趣,请点击[使用文档](./document)帮助我们改进文档,或者点击页面下方的 `帮助我们改善此页面!` -请点击[使用文档](./document)进一步查看相关内容 +我们十分感谢每一位 contributor 作出的贡献!是你们让 Project X 变得更加强大! diff --git a/docs/guide/config.md b/docs/guide/config.md index 51ea332d4..8c8e9fb96 100644 --- a/docs/guide/config.md +++ b/docs/guide/config.md @@ -3,7 +3,7 @@ lang: zh-CN title: 配置运行 --- -[下载并安装](../install) 了 Xray 之后,您需要对它进行一下配置。 +[下载并安装](./install) 了 Xray 之后,您需要对它进行一下配置。 为了演示,这里只介绍简单的配置方式. @@ -100,4 +100,4 @@ title: 配置运行 - 运行 `xray run -c /etc/xray/config.json` - 或使用 systemd 等工具将 Xray 作为服务在后台运行。 -更多详细的说明可以参考 [配置文档](../../config) 和 [使用心得](../../documents)。 +更多详细的说明可以参考 [配置文档](../config) 和 [使用心得](../documents)。 diff --git a/docs/guide/install.md b/docs/guide/install.md index 080b55501..f195e75fb 100644 --- a/docs/guide/install.md +++ b/docs/guide/install.md @@ -35,13 +35,13 @@ Xray 提供两种验证方式: ## Windows 安装方式 -- 在 [Github Releases](https://github.com/xtls/Xray-core/releases) 下载适用于 Windows 平台的 ZIP 压缩包,解压后可得到可执行文件 `xray.exe`,然后[通过命令行带参数运行](../command) 即可 +- 在 [Github Releases](https://github.com/xtls/Xray-core/releases) 下载适用于 Windows 平台的 ZIP 压缩包,解压后可得到可执行文件 `xray.exe`,然后[通过命令行带参数运行](./command) 即可 - 通过 [Scoop](https://scoop.sh) 包管理器安装:Xray 已经被添加到 [Mochi](https://github.com/Qv2ray/mochi)。 - 通过 [Chocolatey](https://chocolatey.org) 包管理器安装:[Xray](https://chocolatey.org/packages/xray/1.3.1),感谢 [Markson](https://chocolatey.org/profiles/markson_ho) ## macOS 安装方式 -- 在 [Github Releases](https://github.com/xtls/Xray-core/releases) 下载适用于 macOS 平台的 ZIP 压缩包,解压后可得到可执行文件 `xray`,然后[通过命令行带参数运行](../command) 即可 +- 在 [Github Releases](https://github.com/xtls/Xray-core/releases) 下载适用于 macOS 平台的 ZIP 压缩包,解压后可得到可执行文件 `xray`,然后[通过命令行带参数运行](./command) 即可 - 通过 [Homebrew](https://brew.sh) 包管理器安装: ## Linux 安装方式 @@ -86,6 +86,6 @@ Linux 发行版 Xray 包(可通过发行版相应的包管理器安装): ## 更多更多... -您可以点击 [传送至众多大佬集结区的任意门](../../links) 获取更多资源 +您可以点击 [传送至众多大佬集结区的任意门](../links) 获取更多资源 ## FAQ