WebCell icon indicating copy to clipboard operation
WebCell copied to clipboard

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

Open TechQuery opened this issue 1 year ago • 5 comments

技术参考

  • TypeStrong/typedoc#2288
  • https://typedoc.org/options/input/#readme

TechQuery avatar Jan 31 '24 17:01 TechQuery

是否考虑不使用 typedoc 生成其它文档?

wangrunlin avatar Feb 07 '24 13:02 wangrunlin

是否考虑不使用 typedoc 生成其它文档?

主要想套用一套文档站的布局。

我们可以只生成一次 TypeDoc,再自己写 TS 脚本读 index.html 来替换正文。

TechQuery avatar Feb 07 '24 14:02 TechQuery

是否考虑不使用 typedoc 生成其它文档?

主要想套用一套文档站的布局。

我们可以只生成一次 TypeDoc,再自己写 TS 脚本读 index.html 来替换正文。

感觉 TypeDoc 官方不支持的话,要做很多改造的内容

wangrunlin avatar Feb 08 '24 08:02 wangrunlin

主要想套用一套文档站的布局。

我们可以只生成一次 TypeDoc,再自己写 TS 脚本读 index.html 来替换正文。

感觉 TypeDoc 官方不支持的话,要做很多改造的内容

我这个方案只需要 zxjsdom 写个几十行的脚本。

TechQuery avatar Feb 08 '24 08:02 TechQuery

另外,Migration 文档后面翻译的时候,首篇引文我翻译了:https://fcc-cd.dev/article/translation/3-reasons-why-i-stopped-using-react-setstate/

TechQuery avatar Feb 09 '24 15:02 TechQuery

虽然已经把所有文档都生成了,但还是建议使用 VitePress, Astro 等工具生成文档站,SEO,翻译等效果会更好。

左侧导航栏也会更清晰,目前的左侧只是源码生成的类型。建议 typedoc 作为文档站的补充。

wangrunlin avatar Aug 13 '24 06:08 wangrunlin

虽然已经把所有文档都生成了,但还是建议使用 VitePress, Astro 等工具生成文档站,SEO,翻译等效果会更好。

WebCell 本身做一个前端组件引擎,如果需要用 Vitepress 这样基于 Vue 等其它引擎来渲染文档,那岂不就招人耻笑了?

我们自己的 SSG、SSR 框架已经初步设计出来了,期待下半年能实现:EasyWebApp/MarkCell#7

左侧导航栏也会更清晰,目前的左侧只是源码生成的类型。建议 typedoc 作为文档站的补充。

但我们目前就是生成的类型信息为主,少量 Markdown 文档为辅。

TechQuery avatar Aug 13 '24 08:08 TechQuery