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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d57366b
[docs] update GitHub and website multilingual documentation links
wangrunlin Jan 31, 2024
0b1ac4e
[docs] explicitly declare html
wangrunlin Jan 31, 2024
e65627f
[docs] set default language
wangrunlin Jan 31, 2024
eb6e0eb
[chore] update multilingual script
wangrunlin Jan 31, 2024
255f30b
[optimize] separate the script files of 'docs' into a separate file
wangrunlin Feb 3, 2024
032b40d
[chore] add prettier-plugin-sh
wangrunlin Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ReadMe-zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![WebCell logo](https://web-cell.dev/WebCell-0.f9823b00.png)

简体中文 | [English](./ReadMe)
简体中文 | [English](./)

基于 VDOM、[JSX][2]、[MobX][3] 和 [TypeScript][4] 的 [Web 组件][1] 引擎

Expand Down
2 changes: 1 addition & 1 deletion ReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![WebCell logo](https://web-cell.dev/WebCell-0.f9823b00.png)

[简体中文](./ReadMe-zh) | English
[简体中文](./ReadMe-zh.md) | English

[Web Components][1] engine based on VDOM, [JSX][2], [MobX][3] & [TypeScript][4]

Expand Down
8 changes: 5 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "web-cell",
"version": "3.0.0-rc.8",
"version": "3.0.0-rc.9",
"description": "Web Components engine based on VDOM, JSX, MobX & TypeScript",
"keywords": [
"web",
Expand Down Expand Up @@ -55,10 +55,11 @@
"jest": "^29.7.0",
"jest-environment-jsdom": "^29.7.0",
"jsdom": "^24.0.0",
"lint-staged": "^15.2.0",
"lint-staged": "^15.2.1",
"open-cli": "^8.0.0",
"parcel": "~2.11.0",
"prettier": "^3.2.4",
"replace": "^1.2.2",
"rimraf": "^5.0.5",
"ts-jest": "^29.1.2",
"ts-node": "^10.9.2",
Expand All @@ -73,7 +74,8 @@
"preview": "npm run clean && cd preview/ && parcel --dist-dir=../docs/preview/ --open",
"pack-preview": "rimraf .parcel-cache/ docs/preview/ && cd preview/ && parcel build --public-url=. --dist-dir=../docs/preview/",
"pack-dist": "parcel build source/index.ts",
"pack-docs": "typedoc source/",
"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 •
edited
Loading

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 •
edited
Loading

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 文件，方便不翻墙的人看。

"build": "npm run clean && npm run pack-dist && npm run pack-docs && npm run pack-preview",
"start": "npm run pack-docs && open-cli docs/index.html",
"prepublishOnly": "npm test && npm run build"
Expand Down
96 changes: 89 additions & 7 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading