{"id":25495449,"url":"https://github.com/keqingmoe/docs","last_synced_at":"2025-04-10T02:41:55.967Z","repository":{"id":252632879,"uuid":"840707624","full_name":"KeqingMoe/docs","owner":"KeqingMoe","description":"一个开放的文档站点","archived":false,"fork":false,"pushed_at":"2024-10-14T06:39:25.000Z","size":152,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T04:12:04.058Z","etag":null,"topics":["documentation","i18n","icu","translation"],"latest_commit_sha":null,"homepage":"https://docs.keqing.moe","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KeqingMoe.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-10T12:47:44.000Z","updated_at":"2024-10-14T06:39:28.000Z","dependencies_parsed_at":"2024-09-15T04:50:36.098Z","dependency_job_id":"694d31a0-24d8-415e-a3ff-cf60dfa9d1b3","html_url":"https://github.com/KeqingMoe/docs","commit_stats":null,"previous_names":["keqingmoe/docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeqingMoe%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeqingMoe%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeqingMoe%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeqingMoe%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KeqingMoe","download_url":"https://codeload.github.com/KeqingMoe/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248144964,"owners_count":21055017,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","i18n","icu","translation"],"created_at":"2025-02-19T00:36:45.083Z","updated_at":"2025-04-10T02:41:55.947Z","avatar_url":"https://github.com/KeqingMoe.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KeiqingMoe Docs: 一个开放的文档站点\n\n用于发布一些文档，以及实现我的翻译计划。\n\n## 序言\n\n在这个信息爆炸的时代，技术文档不仅是知识的载体，更是开源精神的体现。\n\n文档对项目的影响是深远的：一份优秀的文档可以使一个项目更易于使用，从而吸引更多的用户和贡献者；一份糟糕的文档可以让一个项目令人望而生畏，从而渐渐被淘汰。\n\n然而，撰写一份优秀的文档仍未成为全球开发者的共识，我们仍然可以看见许多乱象：\n\n- 文档缺少更新与维护，已经跟不上库本身。\n- 文档缺少关键细节，用户不得不自己摸索。\n- 文档质量粗制滥造、夹带私货、政治导向、机器翻译。\n- 完全没有或几乎没有提供入门指南，或不提供代码示例。\n- 作为全球最好的国际化与本地化库，其自身的文档却并没有实现国际化。\n\n我能够理解，或许由于以下原因，撰写一份优秀的文档是困难的：\n\n- 语言不通。\n- 人力有限，撰写文档成本过高。\n- 文档内容总量过大，检查与校验变得困难。\n- 生理或精神疾病导致撰写文档的难度超过个人能力。\n- 贡献者团队膨胀，个人习惯不同，各人撰写的文档质量良莠不齐。\n\n所以，身为开源社区的成员、各种库的使用者，我决定参与其中，为项目文档的建设出一份力。我会在这个项目下发布我自己的项目的文档，以及一些外语（目前主要是英语）文档的翻译。\n\n立项的动机是什么？\n- 我正在研究 C++ 翻译阶段，其中不可避免地涉及到处理 Unicode。了解 ICU 库后，我被语言不通的文档拒之门外，又被薄弱的社区内容逼不得已，故此立项。\n\n我将如何避免以上的问题？\n\n- 我会保证在我的项目更新时同步更新文档，无文档则不更新。\n- 我会采取 AI 辅助人工翻译的方式，针对一些外语文档进行翻译，保证翻译的质量。\n\n## 当前目标\n\n- 翻译 ICU 的文档（进行中）\n\n## 部署\n\n本项目基于 VitePress，在运行前先安装依赖：\n\n```shell\nnpm install\n```\n\n以开发模式运行（无需构建即可预览）：\n\n```shell\nnpm run docs:dev\n```\n\n构建：\n```shell\nnpm run docs:build\n```\n\n在本地部署：\n```shell\nnpm run docs:preview\n```\n\n将其部署到静态页面托管平台（如 Github Pages 或 Cloudflare Pages）的流程与其他基于 VitePress 的项目基本相同。\n\n## 仓库信息\n\n源代码现已从我的 Gitea 迁移到 Github。\n\n目前已部署于 [docs.keqing.moe](https://docs.keqing.moe) ，如果无法访问，可以自行在本地部署。\n\n## 加入我们\n\n仅凭我个人力量维持这个项目是困难的，我们需要你的帮助。\n\n如果你愿意参与其中，你可以任选一种方式：\n- 提交 PR\n- 与我联系，获取协作者权限\n\n我的联系方式：\n- 我的 [Github](https://github.com/keqingmoe)\n- 我的 [Email: me@keqing.moe](mailto:me@keqing.moe)\n- 我的 [Telegram](https://t.me/keqingmoe)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeqingmoe%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeqingmoe%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeqingmoe%2Fdocs/lists"}