chore(docs): add frontend typedoc

ArtalkJS · Oct 19, 2024 · 20d6e7e · 20d6e7e
1 parent 4ad0cc1
commit 20d6e7e
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 0 deletions.
diff --git a/docs/docs/.vitepress/config/en.ts b/docs/docs/.vitepress/config/en.ts
@@ -84,6 +84,7 @@ export const en = defineConfig({
             { text: 'Import to Framework', link: '/en/develop/import-framework.md' },
             { text: 'Frontend API', link: '/en/develop/fe-api.md' },
             { text: 'Frontend Event', link: '/en/develop/event.md' },
+            { text: 'Frontend Types', link: 'https://artalk.js.org/typedoc/' },
             { text: 'Plugin Development', link: '/en/develop/plugin.md' },
             { text: 'Compatibility', link: '/en/develop/compatibility.md' },
             {

diff --git a/docs/docs/.vitepress/config/zh.ts b/docs/docs/.vitepress/config/zh.ts
@@ -87,6 +87,7 @@ export const zh = defineConfig({
             { text: '置入框架', link: '/zh/develop/import-framework.md' },
             { text: '前端 API', link: '/zh/develop/fe-api.md' },
             { text: '前端 Event', link: '/zh/develop/event.md' },
+            { text: '前端 Types', link: 'https://artalk.js.org/typedoc/' },
             { text: '插件开发', link: '/zh/develop/plugin.md' },
             { text: '兼容性', link: '/zh/develop/compatibility.md' },
             {

diff --git a/docs/docs/en/develop/fe-api.md b/docs/docs/en/develop/fe-api.md
@@ -1,5 +1,9 @@
 # Frontend API
 
+Here are some of the main Artalk client APIs for operating the Artalk instance in frontend code.
+
+For more detailed API information, you can browse the [TypeDoc documentation](https://artalk.js.org/typedoc/).
+
 ## Install Dependencies
 
 Use your preferred package manager to install Artalk:

diff --git a/docs/docs/en/develop/index.md b/docs/docs/en/develop/index.md
@@ -13,6 +13,7 @@ Thank you for your interest and support of Artalk. We deeply understand that the
 - [Embed in Blog](./import-blog.md)
 - [Embed in Framework](./import-framework.md)
 - [Frontend API Documentation](./fe-api.md)
+- [Frontend Type Documentation](https://artalk.js.org/typedoc/)
 - [Frontend Events](./event.md)
 - [Frontend Configuration](../guide/frontend/config.md)
 

diff --git a/docs/docs/zh/develop/fe-api.md b/docs/docs/zh/develop/fe-api.md
@@ -1,5 +1,9 @@
 # Frontend API
 
+以下列出了一些主要的 Artalk 客户端 API，用于在前端代码中操作 Artalk 实例。
+
+更多详细 API 信息可以通过 [TypeDoc 文档](https://artalk.js.org/typedoc/) 浏览。
+
 ## 安装依赖
 
 用你喜欢的包管理器安装 Artalk：

diff --git a/docs/docs/zh/develop/index.md b/docs/docs/zh/develop/index.md
@@ -13,6 +13,7 @@
 - [置入博客](./import-blog.md)
 - [置入框架](./import-framework.md)
 - [前端 API 文档](./fe-api.md)
+- [前端 TypeDoc 文档](https://artalk.js.org/typedoc/)
 - [前端 Event](./event.md)
 - [前端配置](../guide/frontend/config.md)