use single-page structure for modules

docs/docusaurus.config.js

@@ -62,7 +62,7 @@ const docusaurusConfig = {
           position: "left",
         },
         {
-          to: "/reference/core/modules/main",
+          to: "/reference/core/main",
           // TODO: change to this when the overview page looks better.
           // to: "/reference",
           activeBasePath: "/reference",
@@ -101,7 +101,7 @@ const docusaurusConfig = {
     announcementBar: {
       id: "new-major-announcement",
       content:
-        "<a target='_blank' rel='noopener noreferrer' href='https://next-auth.js.org'>NextAuth.js</a> is becoming Auth.js! 🎉 We're creating Authentication for the Web. Everyone included. Starting with SvelteKit, check out <a href='/reference/sveltekit'>the docs</a>.",
+        "<a target='_blank' rel='noopener noreferrer' href='https://next-auth.js.org'>NextAuth.js</a> is becoming Auth.js! 🎉 We're creating Authentication for the Web. Everyone included. Starting with SvelteKit, check out <a href='/reference/sveltekit'>the docs</a>. Note, this site is under active development.",
       backgroundColor: "#000",
       textColor: "#fff",
     },
@@ -201,38 +201,35 @@ const docusaurusConfig = {
       {
         ...typedocConfig,
         id: "core",
-        plugin: ["./tyepdoc"],
+        plugin: [require.resolve("./typedoc-mdn-links")],
+        watch: process.env.TYPEDOC_WATCH,
         entryPoints: ["index.ts", "adapters.ts", "errors.ts", "jwt.ts", "types.ts"].map((e) => `${coreSrc}/${e}`).concat(providers),
         tsconfig: "../packages/core/tsconfig.json",
         out: "reference/03-core",
-        watch: process.env.TYPEDOC_WATCH,
-        includeExtension: false,
       },
     ],
     [
       "docusaurus-plugin-typedoc",
       {
         ...typedocConfig,
         id: "sveltekit",
-        plugin: ["./tyepdoc"],
+        plugin: [require.resolve("./typedoc-mdn-links")],
+        watch: process.env.TYPEDOC_WATCH,
         entryPoints: ["index.ts", "client.ts"].map((e) => `../packages/frameworks-sveltekit/src/lib/${e}`),
         tsconfig: "../packages/frameworks-sveltekit/tsconfig.json",
         out: "reference/04-sveltekit",
-        watch: process.env.TYPEDOC_WATCH,
-        includeExtension: false,
       },
     ],
     [
       "docusaurus-plugin-typedoc",
       {
         ...typedocConfig,
         id: "firebase-adapter",
-        plugin: ["./tyepdoc"],
+        plugin: [require.resolve("./typedoc-mdn-links")],
+        watch: process.env.TYPEDOC_WATCH,
         entryPoints: ["../packages/adapter-firebase/src/index.ts"],
         tsconfig: "../packages/adapter-firebase/tsconfig.json",
         out: "reference/adapter/firebase",
-        watch: process.env.TYPEDOC_WATCH,
-        includeExtension: false,
         sidebar: {
           position: 1,
           indexLabel: "Firebase",

docs/package.json

@@ -37,7 +37,9 @@
     "@docusaurus/preset-classic": "2.2.0",
     "@docusaurus/theme-common": "2.2.0",
     "@docusaurus/types": "2.2.0",
-    "docusaurus-plugin-typedoc": "^0.18.0"
+    "docusaurus-plugin-typedoc": "https://gitpkg.now.sh/balazsorban44/typedoc-plugin-markdown/packages/docusaurus-plugin-typedoc?next",
+    "typedoc": "^0.23.24",
+    "typedoc-plugin-markdown": "https://gitpkg.now.sh/balazsorban44/typedoc-plugin-markdown/packages/typedoc-plugin-markdown?next"
   },
   "browserslist": {
     "production": [

docs/sidebars.js

@@ -20,38 +20,22 @@ module.exports = {
       label: "@auth/core",
       link: {
         type: "doc",
-        id: "reference/core/modules/main",
+        id: "reference/core/main",
       },
       items: [
         {
           type: "autogenerated",
-          dirName: "reference/03-core/modules",
+          dirName: "reference/03-core",
           // See: https://github.com/facebook/docusaurus/issues/5689
           // exclude: ["index"],
         },
-        {
-          type: "category",
-          label: "Reflections",
-          collapsed: true,
-          className: "reflection-category", // See src/index.css
-          items: [{ type: "autogenerated", dirName: "reference/03-core" }],
-        },
       ],
     },
     {
       type: "category",
       label: "@auth/sveltekit",
-      link: { type: "doc", id: "reference/sveltekit/modules/main" },
-      items: [
-        { type: "autogenerated", dirName: "reference/04-sveltekit/modules" },
-        {
-          type: "category",
-          label: "Reflections",
-          collapsed: true,
-          className: "reflection-category", // See src/index.css
-          items: [{ type: "autogenerated", dirName: "reference/04-sveltekit" }],
-        },
-      ],
+      link: { type: "doc", id: "reference/sveltekit/main" },
+      items: [{ type: "autogenerated", dirName: "reference/04-sveltekit" }],
     },
     {
       type: "category",

docs/typedoc.json

@@ -1,27 +1,17 @@
 {
-  "excludeNotDocumented": true,
   "$schema": "https://typedoc.org/schema.json",
+  "cleanOutputDir": true,
   "disableSources": true,
-  "hideBreadcrumbs": true,
   "excludeExternals": true,
   "excludeInternal": true,
+  "excludeNotDocumented": true,
   "excludePrivate": true,
-  "cleanOutputDir": true,
   "excludeProtected": true,
+  "fileStructure": "modules",
   "gitRevision": "main",
+  "hideBreadcrumbs": true,
   "hideGenerator": true,
-  "intentionallyNotExported": [
-    "ReturnTypes",
-    "CallbackParameters",
-    "JsonValue"
-  ],
-  "readme": "none",
-  "sort": [
-    "kind",
-    "static-first",
-    "required-first",
-    "alphabetical"
-  ],
+  "includeExtension": false,
   "kindSortOrder": [
     "Function",
     "TypeAlias",
@@ -45,5 +35,13 @@
     "IndexSignature",
     "GetSignature",
     "SetSignature"
-  ]
+  ],
+  "readme": "none",
+  "sort": [
+    "kind",
+    "static-first",
+    "required-first",
+    "alphabetical"
+  ],
+  "symbolsWithOwnFile": "none"
 }

package.json

@@ -12,7 +12,7 @@
     "dev:db": "turbo run dev --parallel --continue --filter=next-auth-app...",
     "dev": "turbo run dev --parallel --continue --filter=next-auth-app... --filter=!./packages/adapter-*",
     "dev:kit": "turbo run dev --parallel --continue --filter=sveltekit-auth-app...",
-    "dev:docs": "turbo run dev --filter=docs...",
+    "dev:docs": "turbo run dev --filter=docs",
     "email": "cd apps/dev/nextjs && pnpm email",
     "eslint": "eslint --cache .",
     "lint": "prettier --check .",
@@ -41,8 +41,6 @@
     "prettier": "2.8.1",
     "prettier-plugin-svelte": "^2.8.1",
     "turbo": "1.6.3",
-    "typedoc": "^0.23.22",
-    "typedoc-plugin-markdown": "^3.14.0",
     "typescript": "4.9.4"
   },
   "engines": {
@@ -64,7 +62,6 @@
       "undici": "5.11.0"
     },
     "patchedDependencies": {
-      "typedoc-plugin-markdown@3.14.0": "patches/typedoc-plugin-markdown@3.14.0.patch",
       "@balazsorban/monorepo-release@0.1.8": "patches/@balazsorban__monorepo-release@0.1.8.patch"
     }
   }

packages/core/src/index.ts

@@ -1,4 +1,8 @@
 /**
+ *
+ * :::warning Experimental
+ * `@auth/core` is under active development.
+ * :::
  *
  * This is the main entry point to the Auth.js library.
  *