Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] update GitHub and website multilingual documentation links #25

Merged
merged 6 commits into from Feb 6, 2024

Conversation

wangrunlin
Copy link
Member

@wangrunlin wangrunlin added bug Something isn't working enhancement New feature or request labels Jan 31, 2024
package.json Outdated
Comment on lines 77 to 78
"pack-docs": "typedoc --readme ReadMe-zh.md && mv docs/index.html ReadMe-zh.html && typedoc source/ && npm run pack-docs-language",
"pack-docs-language": "mv ReadMe-zh.html docs/ && replace './ReadMe-zh.md' './ReadMe-zh.html' docs/index.html",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

还有其它 Markdown 文档怎么办?我是打算用这里的插件一次性解决:TypeStrong/typedoc#2288 (comment)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://www.npmjs.com/package/@knodes/typedoc-plugin-pages#compatibility

只有 typedoc 0.23 可用,需要改造下,我刚才使用过这个方案,没跑起来才放弃了

Copy link
Member

@TechQuery TechQuery Jan 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://www.npmjs.com/package/@knodes/typedoc-plugin-pages#compatibility

只有 typedoc 0.23 可用,需要改造下,我刚才使用过这个方案,没跑起来才放弃了

连升两个大版本,原作者搞不过来了:KnodesCommunity/typedoc-plugins#369

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

已更新多语言脚本

Copy link
Member

@TechQuery TechQuery Feb 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

还有其它 Markdown 文档怎么办?

@wangrunlin 这一条其实没做啊,不符合 issue 的要求:其它所有 Markdown 文件可以先不翻译,但也要生成 HTML 文件,方便不翻墙的人看。

package.json Outdated Show resolved Hide resolved
pack-docs.sh Outdated Show resolved Hide resolved
@TechQuery TechQuery merged commit 9d00830 into main Feb 6, 2024
1 check passed
@TechQuery TechQuery self-assigned this Feb 6, 2024
@TechQuery TechQuery deleted the docs branch February 6, 2024 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

将所有 Markdown 文件生成到 API 文档站
2 participants