From 20d6e7e36786617934c72b5262673b6b426b821a Mon Sep 17 00:00:00 2001 From: qwqcode Date: Sat, 19 Oct 2024 14:28:37 +0800 Subject: [PATCH] chore(docs): add frontend typedoc --- docs/docs/.vitepress/config/en.ts | 1 + docs/docs/.vitepress/config/zh.ts | 1 + docs/docs/en/develop/fe-api.md | 4 ++++ docs/docs/en/develop/index.md | 1 + docs/docs/zh/develop/fe-api.md | 4 ++++ docs/docs/zh/develop/index.md | 1 + 6 files changed, 12 insertions(+) diff --git a/docs/docs/.vitepress/config/en.ts b/docs/docs/.vitepress/config/en.ts index 81a54938..7ecbf014 100644 --- 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 index 7dc1dafb..3043ebc2 100644 --- 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 index b35be57f..fb4061d2 100644 --- 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 index b85abdde..d167d1dd 100644 --- 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 index 40ea5992..f6351e83 100644 --- 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 index c9e483cb..6b6c95c8 100644 --- 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)