文档国际化问题

[boboqun]

大佬我想帮你翻译英文文档。请问我该如何组织目录结构。 您用的这个文档框架是什么？有没有个国际化的小 demo 或者其他注意事项？ 第一次想做这个事，还请大佬指教。

[liangjingkanji]

文档框架使用的是mkdocs

国际化步骤

翻译

1. fork本仓库, 然后从master拉取新的分支为pages-en
2. 然后将其分支下docs目录下的所有*.md文件内容全部翻译成英语即可

发布

• 本地测试文档, 安装mkdocs工具到本地电脑

• 自动发布文档, 修改.github/workflows/main.xml文件内的- master为- pages-en, 每次对pages-en分支push都会触发自动更新文档

提交

复制你fork的仓库的master分支下的README文件为README-EN, 然后翻译并且发起PR给我

[boboqun]

收到 我试下

[boboqun]

踩坑记录 brew 安装 mkdocs 仿佛有问题，官方推荐使用 pip 安装。

本仓库内的 material 主题需要先安装一下 不然无法编译成功 pip install mkdocs-material

[liangjingkanji]

直接安装mkdocs-material会自动安装mkdocs

python3 -m pip install mkdocs-material

[boboqun]

我翻译好了一个文档，想要给你看看的话 应该怎么操作？我看创建 PR 的话 只能往master合并，感觉不太对。

[liangjingkanji]

site目录不需要提交, 你把docs里面的.md文件翻译一遍提交上来, 然后我拉取你的仓库帮你pr

生成的英文文档会在你的仓库下生成Pages地址, 就和BRV官方仓库地址一样

比如你的是https://boboqun.github.io/BRV/

[boboqun]

嗯那 site 已经删了

[boboqun]

https://github.com/boboqun/BRV/blob/pages-en/docs/index.md 这是我最近翻译的，大佬你看一眼。觉得还可以接受的话，我就继续翻译。

[liangjingkanji]

很不错

[TxcA]

https://github.com/boboqun/BRV/blob/pages-en/docs/index.md 这是我最近翻译的，大佬你看一眼。觉得还可以接受的话，我就继续翻译。

感觉很棒！顺道可以看下Net 👍

[liangjingkanji]

希望你可以让更多国外开发者来贡献高质量代码

[shenbengit]

site目录不需要提交, 你把docs里面的.md文件翻译一遍提交上来, 然后我拉取你的仓库帮你pr

生成的英文文档会在你的仓库下生成Pages地址, 就和BRV官方仓库地址一样

比如你的是https://boboqun.github.io/BRV/

大佬，我这边使用chatgpt 做了英文文档，仓库地址，是我提pr，还是你自己拉呢。

[liangjingkanji]

@shenbengit 好的多谢贡献，等我检查下翻译内容

[liangjingkanji]

site目录不需要提交, 你把docs里面的.md文件翻译一遍提交上来, 然后我拉取你的仓库帮你pr 生成的英文文档会在你的仓库下生成Pages地址, 就和BRV官方仓库地址一样 比如你的是https://boboqun.github.io/BRV/

大佬，我这边使用chatgpt 做了英文文档，仓库地址，是我提pr，还是你自己拉呢。

可以将README也翻译一遍吗? 我会在本仓库直接指向你仓库的Pages页面, 所以不需要Pr

[shenbengit]

site目录不需要提交, 你把docs里面的.md文件翻译一遍提交上来, 然后我拉取你的仓库帮你pr 生成的英文文档会在你的仓库下生成Pages地址, 就和BRV官方仓库地址一样 比如你的是https://boboqun.github.io/BRV/

大佬，我这边使用chatgpt 做了英文文档，仓库地址，是我提pr，还是你自己拉呢。

可以将README也翻译一遍吗? 我会在本仓库直接指向你仓库的Pages页面, 所以不需要Pr

看下README.md，有啥需要调整的再修改。

[liangjingkanji]

@shenbengit 非常谢谢你贡献的英文文档, 你让这个项目寿命更加长久

为了遵守你的劳动贡献成果建议你发起pr

1. 将你翻译的README.md重命名为README_EN.md移动到本仓库根目录(因为README更新可能比较频繁方便后续维护)

2. 添加以下代码到本仓库README.md最上面

<p >
    <a href="http://liangjingkanji.github.io/BRV/">中文</a>
    | <a href="https://github.com/liangjingkanji/BRV/blob/master/README_EN.md">English</a>
</p>

[shenbengit]

@shenbengit 非常谢谢你贡献的英文文档, 你让这个项目寿命更加长久

为了遵守你的劳动贡献成果建议你发起pr

1. 将你翻译的README.md重命名为README_EN.md移动到本仓库根目录(因为README更新可能比较频繁方便后续维护)
2. 添加以下代码到本仓库README.md最上面

<p >
    <a href="http://liangjingkanji.github.io/BRV/">中文</a>
    | <a href="https://github.com/liangjingkanji/BRV/blob/master/README_EN.md">English</a>
</p>

https://github.com/liangjingkanji/BRV/pull/366 提了。