chore: 📝 update docs

willin · Dec 31, 2023 · 9397876 · 9397876
1 parent a11b4ed
commit 9397876
Show file tree

Hide file tree

Showing 22 changed files with 49 additions and 235 deletions.
diff --git a/.changeset/empty-rings-jog.md b/.changeset/empty-rings-jog.md
@@ -0,0 +1,9 @@
+---
+"@svelte-dev/auth-sso": patch
+"@svelte-dev/session": patch
+"@svelte-dev/auth": patch
+"@svelte-dev/i18n": patch
+"web": patch
+---
+
+remove typedocs
diff --git a/.changeset/warm-garlics-visit.md b/.changeset/warm-garlics-visit.md
@@ -0,0 +1,5 @@
+---
+"@svelte-dev/auth-sso": patch
+---
+
+change sso endpoint
diff --git a/README.md b/README.md
@@ -6,18 +6,15 @@
 
 ### Packages
 
-| Package                                          | Meta                                                                                                                                                                                                                                                                                                                                                                                                                                         | Docs                                         | Changelog                                      |
-| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ---------------------------------------------- |
-| [@svelte-dev/session](packages/session/)         | [![npm](https://img.shields.io/npm/v/@svelte-dev/session?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/session) [![npm](https://img.shields.io/npm/dm/@svelte-dev/session?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/session) [![npm](https://img.shields.io/npm/dt/@svelte-dev/session?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/session)                         | [Docs](https://svelte.js.cool/docs/session/) | [Changelog](packages/session/CHANGELOG.md)     |
-| [@svelte-dev/auth](packages/auth/)               | [![npm](https://img.shields.io/npm/v/@svelte-dev/auth?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth)                                           | [Docs](https://svelte.js.cool/docs/auth/)    | [Changelog](packages/auth/CHANGELOG.md)        |
-| [@svelte-dev/i18n](packages/i18n/)               | [![npm](https://img.shields.io/npm/v/@svelte-dev/i18n?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/i18n) [![npm](https://img.shields.io/npm/dm/@svelte-dev/i18n?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/i18n) [![npm](https://img.shields.io/npm/dt/@svelte-dev/i18n?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/i18n)                                           | [Docs](https://svelte.js.cool/docs/i18n/)    | [Changelog](packages/i18n/CHANGELOG.md)        |
-| [@svelte-dev/auth-oauth2](packages/auth-oauth2/) | [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-oauth2?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-oauth2) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-oauth2?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-oauth2) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-oauth2?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-oauth2) |                                              | [Changelog](packages/auth-oauth2/CHANGELOG.md) |
-| [@svelte-dev/auth-github](packages/auth-github/) | [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-github?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-github) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-github?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-github) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-github?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-github) |                                              | [Changelog](packages/auth-github/CHANGELOG.md) |
-| [@svelte-dev/auth-alipay](packages/auth-alipay/) | [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-alipay?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-alipay) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-alipay?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-alipay) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-alipay?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-alipay) |                                              | [Changelog](packages/auth-alipay/CHANGELOG.md) |
-| [@svelte-dev/auth-afdian](packages/auth-afdian/) | [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-afdian?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-afdian) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-afdian?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-afdian) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-afdian?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-afdian) |                                              | [Changelog](packages/auth-afdian/CHANGELOG.md) |
-| [@svelte-dev/auth-sso](packages/auth-sso/)       | [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-sso?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-sso) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-sso?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-sso) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-sso?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-sso)                   |                                              | [Changelog](packages/auth-sso/CHANGELOG.md)    |
-
-[Webiste](https://svelte.js.cool) is under [apps/web](apps/web/).
+- [@svelte-dev/session](packages/session/) [![npm](https://img.shields.io/npm/v/@svelte-dev/session?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/session) [![npm](https://img.shields.io/npm/dm/@svelte-dev/session?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/session) [![npm](https://img.shields.io/npm/dt/@svelte-dev/session?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/session) [Docs](https://svelte.js.cool/docs/session/) [![](https://img.shields.io/badge/CHANGELOG-md-blue)](packages/session/CHANGELOG.md) |
+- [@svelte-dev/auth](packages/auth/) [![npm](https://img.shields.io/npm/v/@svelte-dev/auth?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth) [Docs](https://svelte.js.cool/docs/auth/) [![](https://img.shields.io/badge/CHANGELOG-md-blue)](packages/auth/CHANGELOG.md) |
+- [@svelte-dev/i18n](packages/i18n/) [![npm](https://img.shields.io/npm/v/@svelte-dev/i18n?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/i18n) [![npm](https://img.shields.io/npm/dm/@svelte-dev/i18n?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/i18n) [![npm](https://img.shields.io/npm/dt/@svelte-dev/i18n?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/i18n) [Docs](https://svelte.js.cool/docs/i18n/) [![](https://img.shields.io/badge/CHANGELOG-md-blue)](packages/i18n/CHANGELOG.md) |
+- [@svelte-dev/auth-oauth2](packages/auth-oauth2/) [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-oauth2?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-oauth2) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-oauth2?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-oauth2) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-oauth2?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-oauth2) [![](https://img.shields.io/badge/CHANGELOG-md-blue)](packages/auth-oauth2/CHANGELOG.md) |
+- [@svelte-dev/auth-github](packages/auth-github/) [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-github?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-github) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-github?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-github) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-github?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-github) [![](https://img.shields.io/badge/CHANGELOG-md-blue)](packages/auth-github/CHANGELOG.md) |
+- [@svelte-dev/auth-alipay](packages/auth-alipay/) [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-alipay?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-alipay) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-alipay?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-alipay) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-alipay?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-alipay) [![](https://img.shields.io/badge/CHANGELOG-md-blue)](packages/auth-alipay/CHANGELOG.md) |
+- [@svelte-dev/auth-afdian](packages/auth-afdian/) [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-afdian?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-afdian) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-afdian?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-afdian) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-afdian?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-afdian) [![](https://img.shields.io/badge/CHANGELOG-md-blue)](packages/auth-afdian/CHANGELOG.md) |
+- [@svelte-dev/auth-sso](packages/auth-sso/) [![npm](https://img.shields.io/npm/v/@svelte-dev/auth-sso?style=flat-square&logo=npm)](https://npmjs.org/package/@svelte-dev/auth-sso) [![npm](https://img.shields.io/npm/dm/@svelte-dev/auth-sso?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-sso) [![npm](https://img.shields.io/npm/dt/@svelte-dev/auth-sso?style=flat-square&label=down)](https://npmjs.org/package/@svelte-dev/auth-sso) [![](https://img.shields.io/badge/CHANGELOG-md-blue)](packages/auth-sso/CHANGELOG.md) |
+  [Webiste](https://svelte.js.cool) is under [apps/web](apps/web/).
 
 ## 赞助 Sponsor
 

diff --git a/apps/web/src/routes/(zh)/auth/+page.md b/apps/web/src/routes/(zh)/auth/+page.md
@@ -7,11 +7,6 @@ desc: 一个简单好用的 Svelte 身份管理库
   import { page } from "$app/stores";
 </script>
 
-```js title="hello.js" /age/#v /name/#v /setAge/#s /setName/#s /50/#i /'Taylor'/#i
-const [age, setAge] = useState(50);
-const [name, setName] = useState('Taylor');
-```
-
 ![Logo](https://repository-images.githubusercontent.com/726691357/f09bf6fc-3844-4584-8eee-6bfb425d8a38)
 
 ## 特性
@@ -194,9 +189,14 @@ export {};
 
 > 欢迎共享您的策略。
 
-## TypeDocs
+## API 文档
 
-[自动化生成的接口文档](/docs/auth/)
+- [API 接口文档](https://paka.dev/npm/@svelte-dev/auth/api)
+- [OAuth2 API 接口文档](https://paka.dev/npm/@svelte-dev/auth-oauth2/api)
+- [Github API 接口文档](https://paka.dev/npm/@svelte-dev/auth-github/api)
+- [Alipay API 接口文档](https://paka.dev/npm/@svelte-dev/auth-alipay/api)
+- [Afdian API 接口文档](https://paka.dev/npm/@svelte-dev/auth-afdian/api)
+- [SSO API 接口文档](https://paka.dev/npm/@svelte-dev/auth-sso/api)
 
 ## 赞助
 

diff --git a/apps/web/src/routes/(zh)/i18n/+page.md b/apps/web/src/routes/(zh)/i18n/+page.md
@@ -96,9 +96,9 @@ import '$lib/i18n';
 {$t('message')}
 ```
 
-## TypeDocs
+## API 文档
 
-[自动化生成的接口文档](/docs/i18n/)
+[API 接口文档](https://paka.dev/npm/@svelte-dev/i18n/api)
 
 ## 赞助
 

diff --git a/apps/web/src/routes/(zh)/session/+page.md b/apps/web/src/routes/(zh)/session/+page.md
@@ -293,9 +293,9 @@ export class YourStrategy<Data = SessionData, FlashData = Data>
 }
 ```
 
-## TypeDocs
+## API 文档
 
-[自动化生成的接口文档](/docs/session/)
+[API 接口文档](https://paka.dev/npm/@svelte-dev/session/api)
 
 ## 赞助
 

diff --git a/apps/web/src/routes/en/auth/+page.md b/apps/web/src/routes/en/auth/+page.md
@@ -186,9 +186,14 @@ export {};
 
 > Welcome to share your strategies here.
 
-## TypeDocs
-
-[API Spec](/docs/auth/)
+## API Spec
+
+- [API Spec](https://paka.dev/npm/@svelte-dev/auth/api)
+- [OAuth2 API Spec](https://paka.dev/npm/@svelte-dev/auth-oauth2/api)
+- [Github API Spec](https://paka.dev/npm/@svelte-dev/auth-github/api)
+- [Alipay API Spec](https://paka.dev/npm/@svelte-dev/auth-alipay/api)
+- [Afdian API Spec](https://paka.dev/npm/@svelte-dev/auth-afdian/api)
+- [SSO API Spec](https://paka.dev/npm/@svelte-dev/auth-sso/api)
 
 ## Sponsor
 

diff --git a/apps/web/src/routes/en/i18n/+page.md b/apps/web/src/routes/en/i18n/+page.md
@@ -96,9 +96,9 @@ Use in page:
 {$t('message')}
 ```
 
-## TypeDocs
+## Api Spec
 
-[API Spec](/docs/i18n/)
+[API Spec](https://paka.dev/npm/@svelte-dev/i18n/api)
 
 ## Sponsor
 

diff --git a/apps/web/src/routes/en/session/+page.md b/apps/web/src/routes/en/session/+page.md
@@ -296,9 +296,9 @@ export class YourStrategy<Data = SessionData, FlashData = Data>
 }
 ```
 
-## TypeDocs
+## API Spec
 
-[API Spec](/docs/session/)
+[API Spec](https://paka.dev/npm/@svelte-dev/session/api)
 
 ## Sponsor
 

diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -2,7 +2,6 @@
   "private": true,
   "scripts": {
     "build": "turbo run build",
-    "build:docs": "turbo run build:docs",
     "dev": "turbo run dev --parallel",
     "test": "turbo run test --parallel",
     "changeset:version": "changeset version",

diff --git a/packages/auth-sso/src/lib/index.ts b/packages/auth-sso/src/lib/index.ts
@@ -58,9 +58,9 @@ export class SSOStrategy<User> extends OAuth2Strategy<User, SSOProfile, SSOExtra
       callbackURL,
       userAgent,
       scope,
-      authorizationURL = 'https://sso.willin.wang/authorize',
-      tokenURL = 'https://sso.willin.wang/token',
-      userInfoURL = 'https://sso.willin.wang/userinfo'
+      authorizationURL = 'https://sso.willin.wang/auth/authorize',
+      tokenURL = 'https://sso.willin.wang/auth/token',
+      userInfoURL = 'https://sso.willin.wang/auth/userinfo'
     }: SSOStrategyOptions,
     verify: StrategyVerifyCallback<User, OAuth2StrategyVerifyParams<SSOProfile, SSOExtraParams>>
   ) {

diff --git a/packages/auth/package.json b/packages/auth/package.json
@@ -28,8 +28,6 @@
   "scripts": {
     "dev": "echo vite dev",
     "build": "vite build && npm run package",
-    "dev:docs": "typedoc --watch",
-    "build:docs": "typedoc",
     "lint": "prettier --write . && eslint . --fix",
     "preview": "vite preview",
     "package": "svelte-kit sync && svelte-package && publint",
@@ -68,10 +66,6 @@
     "svelte": "^5.0.0-next.22",
     "svelte-check": "^3.6.0",
     "tslib": "^2.4.1",
-    "typedoc-plugin-extras": "^3.0.0",
-    "typedoc-plugin-google-ads": "^1.6.0",
-    "typedoc-plugin-keywords": "^1.6.0",
-    "typedocs": "^0.6.7",
     "typescript": "^5.0.0",
     "vite": "^4.4.2",
     "vitest": "^0.34.0"

diff --git a/packages/auth/tsconfig.typedoc.json b/packages/auth/tsconfig.typedoc.json
diff --git a/packages/auth/typedoc.json b/packages/auth/typedoc.json
diff --git a/packages/i18n/package.json b/packages/i18n/package.json
@@ -24,8 +24,6 @@
   "scripts": {
     "dev": "echo vite dev",
     "build": "vite build && npm run package",
-    "dev:docs": "typedoc --watch",
-    "build:docs": "typedoc",
     "lint": "prettier --write . && eslint . --fix",
     "preview": "vite preview",
     "package": "svelte-kit sync && svelte-package && publint",
@@ -64,10 +62,6 @@
     "svelte": "^5.0.0-next.22",
     "svelte-check": "^3.6.0",
     "tslib": "^2.4.1",
-    "typedoc-plugin-extras": "^3.0.0",
-    "typedoc-plugin-google-ads": "^1.6.0",
-    "typedoc-plugin-keywords": "^1.6.0",
-    "typedocs": "^0.6.7",
     "typescript": "^5.0.0",
     "vite": "^4.4.2",
     "vitest": "^0.34.0"

diff --git a/packages/i18n/tsconfig.typedoc.json b/packages/i18n/tsconfig.typedoc.json
diff --git a/packages/i18n/typedoc.json b/packages/i18n/typedoc.json
diff --git a/packages/session/package.json b/packages/session/package.json
@@ -26,8 +26,6 @@
   "scripts": {
     "dev": "echo vite dev",
     "build": "vite build && npm run package",
-    "dev:docs": "typedoc --watch",
-    "build:docs": "typedoc",
     "lint": "prettier --write . && eslint . --fix",
     "preview": "vite preview",
     "package": "svelte-kit sync && svelte-package && publint",
@@ -67,10 +65,6 @@
     "svelte": "^5.0.0-next.22",
     "svelte-check": "^3.6.0",
     "tslib": "^2.4.1",
-    "typedoc-plugin-extras": "^3.0.0",
-    "typedoc-plugin-google-ads": "^1.6.0",
-    "typedoc-plugin-keywords": "^1.6.0",
-    "typedocs": "^0.6.7",
     "typescript": "^5.0.0",
     "vite": "^4.4.2",
     "vitest": "^0.34.0"

diff --git a/packages/session/tsconfig.typedoc.json b/packages/session/tsconfig.typedoc.json