个人看法也是看当前库的受众,如果仅限国内用户,只需中文文档即可;否则的话,默认语言应该还是以国际通用语言英语为主,然后可以加上中文文档链接。
哈哈哈,打个广告,后续皆为广告😊
之前我也为如何同时维护多个语言的 README 文档而发愁,因为文档的内容或者结构发生变化,然后又需要调整多个语言的文档还是挺繁琐的。然后采用了一个策略,将 Markdown 文件当做是产出的资源,通过 js 代码来动态生成,这样不同语言就可以抽取出独立的语言包,整个文档结构是在代码中固定的,后续调整只改 js 代码的结构而不用每个语言都改,这样就看似很像日常前端开发中给前端页面添加多语言功能。
然后,上述的这套逻辑,已装了一个工具
https://github.com/eyelly-wu/jsx-to-md ,它可以像平常写 React 一样来编写 Markdown ,举个例子
// 这里文案的内容通过 t 函数标记了,是需要多语言处理的内容
export function Temp(){
return (
<>
t('这是一段中文描述,这是后续的描述内容')
</>
)
}
然后再配上另一个国际化的工具
https://github.com/i18n-pro/core ,它可以识别出需要翻译的内容(例如上述代码示例中的“这是一段中文描述,这是后续的描述内容”),并调用第三方翻译平台的接口(例如 谷歌和 OpenAI 等,还不止这些)对内容进行翻译并生成生成各自语言的语言包(当然翻译的内容效果不保证一定很理想,但是调整语言包也很方便)
有了语言包,以及固定的文档结构,就能生成不同语言但结构相同的 Markdown 文档了。后续无论是文档内容的变化或者是新增语言的支持,都将变更轻松很多。
最后,上面提到的两个工具的中英文文档都是这样生成的,热烈欢迎各位开发者朋友的尝试😊