Update document/command.md & (#472)
Standardized uppercase / downcase & Renamed '.github/CONTRIBUTING.md' -> './CODE_OF_CONDUCT.md'pull/473/head
チセ
GitHub
parent
4cf6e9818e
commit
f760fd1d45
|
|
@ -8,7 +8,7 @@ Project X 的文档托管在 [GitHub](https://github.com/XTLS/Xray-docs-next)
|
|||
|
||||
您可以通过以下步骤, 提交您对文档的改动:
|
||||
|
||||
1. 从 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库.
|
||||
1. 从 [Project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库.
|
||||
|
||||
2. 使用任何您喜欢的工具, 从您克隆的仓库获得文档的克隆, 如:
|
||||
|
||||
|
|
@ -24,11 +24,11 @@ git checkout -b your-branch
|
|||
|
||||
4. 在新分支上做修改。
|
||||
|
||||
注：在修改时请注意遵循 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)
|
||||
注：推荐 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)
|
||||
|
||||
5. 修改完成后，请格式化您的更改。建议使用 Prettier
|
||||
5. 修改完成后，请使用 [Prettier](https://prettier.io/docs/en/install.html) 格式化您的更改。
|
||||
|
||||
注：存在格式问题或不遵循中文文案排版指北的 PR，将有可能被拒绝。
|
||||
注：存在格式问题的 PR，将有可能被拒绝。
|
||||
|
||||
6. 提交修改，并推送到您的仓库中
|
||||
|
||||
|
|
@ -1,12 +1,12 @@
|
|||
# project X 的文档网站
|
||||
# Project X 的文档网站
|
||||
|
||||
## 关于网站
|
||||
|
||||
- 网站包含了 [project X 文档网站](https://xtls.github.io/) 所呈现的所有内容.
|
||||
- 网站包含了 [Project X 文档网站](https://xtls.github.io/) 所呈现的所有内容.
|
||||
|
||||
## 帮助我们改进网站
|
||||
|
||||
- 请参照 [改进文档步骤](https://xtls.github.io/document/document.html)
|
||||
- 请参照 [改进文档步骤](./CODE_OF_CONDUCT.md)
|
||||
|
||||
- 当成功向仓库提交了修改或 PR 被 merge 后, 会自动重新构建. 只需稍等片刻, 就可以在网站上看到修改的最新呈现.
|
||||
|
||||
|
|
|
|||
|
|
@ -83,9 +83,9 @@ footer: Licensed under CC-BY-SA 4.0 | Copyright 2020-Present Project X Community
|
|||
- 感谢提出有意义的建议和意见的朋友们.
|
||||
- 感谢 Telegram 群每一位帮助群友的朋友.
|
||||
|
||||
### 更多关于 project X
|
||||
### 更多关于 Project X
|
||||
|
||||
- 如果你想知道更多关于 project X 的足迹与成长, 请点击[这里](./about/news.md)
|
||||
- 如果你想知道更多关于 Project X 的足迹与成长, 请点击[这里](./about/news.md)
|
||||
|
||||
### License
|
||||
|
||||
|
|
|
|||
|
|
@ -4,12 +4,12 @@
|
|||
|
||||
### 版本控制
|
||||
|
||||
project X 的代码被托管在 github 上:
|
||||
Project X 的代码被托管在 github 上:
|
||||
|
||||
- xray 核心 [xray-core](https://github.com/XTLS/Xray-core)
|
||||
- Xray 核心 [Xray-core](https://github.com/XTLS/Xray-core)
|
||||
- 安装脚本 [Xray-install](https://github.com/XTLS/Xray-install)
|
||||
- 配置模板 [Xray-examples](https://github.com/XTLS/Xray-examples)
|
||||
- xray 文档 [Xray-docs-next](https://github.com/XTLS/Xray-docs-next)
|
||||
- Xray 文档 [Xray-docs-next](https://github.com/XTLS/Xray-docs-next)
|
||||
|
||||
您可以使用 [Git](https://git-scm.com/) 来获取代码。
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ project X 的代码被托管在 github 上:
|
|||
### 引用其它项目
|
||||
|
||||
- Golang
|
||||
- 产品代码建议使用 Golang 标准库和 [golang.org/x/](https://pkg.go.dev/search?q=golang.org%2Fx) 下的库；
|
||||
- 产品代码建议使用 Golang 标准库和 [golang.org/x/](https://pkg.go.dev/search?limit=25&m=package&q=golang.org%2Fx) 下的库；
|
||||
- 如需引用其它项目，请事先创建 issue 讨论；
|
||||
- 其它
|
||||
- 不违反双方的协议，且对项目有帮助的工具，都可以使用。
|
||||
|
|
@ -56,17 +56,17 @@ project X 的代码被托管在 github 上:
|
|||
|
||||
### Pull Request
|
||||
|
||||
- 提交 PR 之前，请先运行 `git pull https://github.com/xray/xray-core.git` 以确保 merge 可顺利进行；
|
||||
- 提交 PR 之前，请先运行 `git pull https://github.com/XTLS/Xray-core.git` 以确保 merge 可顺利进行；
|
||||
- 一个 PR 只做一件事，如有对多个 bug 的修复，请对每一个 bug 提交一个 PR；
|
||||
- 由于 Golang 的特殊需求（Package path），Go 项目的 PR 流程和其它项目有所不同，建议流程如下：
|
||||
1. 先 Fork 本项目，创建你自己的 `github.com/<your_name>/Xray-core.git` 仓库；
|
||||
2. 克隆你自己的 Xray 仓库到本地：`git clone https://github.com/<your_name>/Xray-core.git`；
|
||||
3. 基于 `main` 分支创建新的分支，例如 `git branch issue24 main`；
|
||||
4. 在新创建的分支上作修改并提交修改(commit)；
|
||||
5. 在推送(push)修改完成的分支到自己的仓库前，先切换到 `main` 分支，运行 `git pull https://github.com/xray/xray-core.git` 拉取最新的远端代码；
|
||||
5. 在推送(push)修改完成的分支到自己的仓库前，先切换到 `main` 分支，运行 `git pull https://github.com/XTLS/Xray-core.git` 拉取最新的远端代码；
|
||||
6. 如果上一步拉取得到了新的远端代码，则切换到之前自己创建的分支，运行 `git rebase main` 执行分支合并操作。如遇到文件冲突，则需要解决冲突；
|
||||
7. 上一步处理完毕后，就可以把自己创建的分支推送到自己的仓库：`git push -u origin your-branch`
|
||||
8. 最后，把自己仓库的新推送的分支往 `xtls/Xray-core` 的 `main` 分支发 PR 即可；
|
||||
8. 最后，把自己仓库的新推送的分支往 `XTLS/Xray-core` 的 `main` 分支发 PR 即可；
|
||||
9. 请在 PR 的标题和正文中，完整表述此次 PR 解决的问题 / 新增的功能 / 代码所做的修改的用意等；
|
||||
10. 耐心等待开发者的回应。
|
||||
|
||||
|
|
|
|||
|
|
@ -42,28 +42,28 @@ Use "xray help <command>" for more information about a command.
|
|||
```
|
||||
Run Xray with config, the default command.
|
||||
|
||||
The -config=file, -c=file flags set the config files for
|
||||
The -config=file, -c=file flags set the config files for
|
||||
Xray. Multiple assign is accepted.
|
||||
|
||||
The -confdir=dir flag sets a dir with multiple json config
|
||||
|
||||
The -format=json flag sets the format of config files.
|
||||
The -format=json flag sets the format of config files.
|
||||
Default "auto".
|
||||
|
||||
The -test flag tells Xray to test config files only,
|
||||
without launching the server
|
||||
```
|
||||
The -test flag tells Xray to test config files only,
|
||||
without launching the server.
|
||||
|
||||
The -dump flag tells Xray to print the merged config.
|
||||
```
|
||||
`-config=` / `-c=` 用于指定使用的配置文件的位置，支持多文件配置。
|
||||
`-confdir=` 用于指定一个包含多个配置文件的文件夹。
|
||||
`-format=` 用于指定使用的配置文件的格式。
|
||||
`-test` 用于测试配置文件的合法性。
|
||||
`-dump` 用于显示多文件配置文件合并之后的效果。
|
||||
::: tip
|
||||
配置文件除了默认的 JSON 格式外，也可以使用 TOML 和 YAML。在不指定格式的前提下会通过文件扩展名识别。
|
||||
:::
|
||||
|
||||
```
|
||||
xray run -dump
|
||||
```
|
||||
|
||||
用以输出多文件配置融合之后的结果。
|
||||
|
||||
### xray version
|
||||
|
||||
输出 Xray 版本、 Golang 版本等信息。
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Project X 的文档托管在 [GitHub](https://github.com/XTLS/Xray-docs-next)
|
|||
|
||||
您可以通过以下步骤, 提交您对文档的改动:
|
||||
|
||||
1. 从 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库.
|
||||
1. 从 [Project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库.
|
||||
|
||||
2. 使用任何您喜欢的工具, 从您克隆的仓库获得文档的克隆, 如:
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ git checkout -b your-branch
|
|||
git push -u origin your-branch
|
||||
```
|
||||
|
||||
6. 打开 GitHub, 点击 'Pull request' 向 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 提交 PR。
|
||||
6. 打开 GitHub, 点击 'Pull request' 向 [Project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 提交 PR。
|
||||
|
||||
7. 请在 PR 的标题和正文中，概述此次 PR 新增/修改的内容等；
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue