Skip to content

zzhx2006/github-cli-manual-zh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub CLI 中文手册

GitHub GitHub deployments GitHub last commit GitHub commit activity GitHub package.json version GitHub watchers

本手册为 GitHub CLI 官方手册 的中文翻译.

请注意,本中译手册非官方翻译. 当本手册与官方英文原版有差异时,请以官方英文原版为准.

仓库构成

本仓库有两个分支:

  • main:主分支,项目的根目录;
  • gh-pagesdocs/dist目录.

手册页的 Markdown 文件在 main 分支的 docs 目录下.

本地构建

本项目由 VitePress 搭建.

需要预先安装 yarn v1.22.19VitePress v1.0.0-alpha.45.

克隆本仓库到本地:

$ git clone https://github.com/ZhangZhanhaoxiang/github-cli-manual-zh.git
$ cd github-cli-manual-zh

本地试运行:

$ yarn docs:dev

VitePress 会在 http://localhost:5173/github-cli-manual-zh/ 热重载一个开发服务器.

构建到 ./docs/dist 目录:

$ yarn docs:build

参与贡献

欢迎各位开源爱好者参与贡献此项目.

当前本项目值得改进的地方包括但不限于:

  • 修正翻译错误;
  • 更正错别字;
  • 修改病句;
  • 优化排版格式;
  • 新增翻译章节;
  • 以官方原版为参照更新章节;
  • 为 VitePress 增添功能.

目前还有 gh help referenceexamples 两个章节缺少翻译.

在编辑章节时,不要忘了在中文和英文之间添加空格.

更多排版技巧,可以参考 LCTT 的中文排版指北.

可以通过以下步骤为本项目做贡献:

  1. Fork 本仓库;
  2. 新建分支;
  3. 修改代码;
  4. commit 修改;
  5. 提交 Pull Request.

感谢为本项目做出贡献的每一位开源爱好者!

许可协议

MIT © Zhanhaoxiang Zhang

Releases

No releases published

Packages

No packages published

Languages