fix: docs

Author: darkbasic

package.json

@@ -23,7 +23,8 @@
     "packages": [
       "modules/*",
       "packages/*",
-      "examples/*"
+      "examples/*",
+      "website"
     ]
   },
   "lint-staged": {

website/docusaurus.config.js

@@ -19,10 +19,6 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
-      algolia: {
-        apiKey: 'c872074b5f5ecd186d94d7c19b27d757',
-        indexName: 'accounts',
-      },
       fathomAnalytics: {
         siteId: 'NZPJJZTJ',
         customDomain: 'https://goose.accountsjs.com',
@@ -40,7 +36,7 @@ const config = {
         items: [
           { to: 'docs/introduction', label: 'Documentation', position: 'right' },
           {
-            to: 'docs/api/server/index',
+            to: 'docs/api/server',
             label: 'Api reference',
             position: 'right',
           },
@@ -63,7 +59,7 @@ const config = {
               },
               {
                 label: 'Api reference',
-                to: '/docs/api/server/index',
+                to: '/docs/api/server',
               },
             ],
           },

website/package.json

@@ -12,16 +12,16 @@
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "generate-api-docs": "rm -rf docs/api && ts-node scripts/generate-api-docs.ts"
+    "generate-api-docs": "rm -rf docs/api && yarn run -T ts-node scripts/generate-api-docs.ts"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.8",
-    "@docusaurus/plugin-content-docs": "2.0.0-beta.8",
-    "@docusaurus/preset-classic": "2.0.0-beta.8",
+    "@docusaurus/core": "2.4.1",
+    "@docusaurus/plugin-content-docs": "2.4.1",
+    "@docusaurus/preset-classic": "2.4.1",
     "@mdx-js/react": "1.6.22",
-    "clsx": "1.1.1",
+    "clsx": "1.2.1",
     "docusaurus-plugin-fathom": "1.1.0",
-    "prism-react-renderer": "1.2.1",
+    "prism-react-renderer": "1.3.5",
     "react": "17.0.2",
     "react-dom": "17.0.2"
   },
@@ -38,10 +38,9 @@
     ]
   },
   "devDependencies": {
-    "@types/node": "20.2.3",
-    "@types/react": "17.0.38",
-    "ts-node": "10.9.1",
-    "typedoc": "0.17.8",
-    "typedoc-plugin-markdown": "2.4.2"
+    "@types/react": "17.0.65",
+    "typedoc": "0.19.2",
+    "typedoc-plugin-markdown": "2.4.2",
+    "typescript": "4.0.8"
   }
 }

website/scripts/generate-api-docs.ts

@@ -3,6 +3,7 @@ import { resolve } from 'path';
 import { Application } from 'typedoc';
 
 const packagesDir = resolve(__dirname, '..', '..', 'packages');
+const modulesDir = resolve(__dirname, '..', '..', 'modules');
 const websiteDir = resolve(__dirname, '..', '..', 'website');
 const apiDocsDir = resolve(__dirname, '..', '..', 'website', 'docs', 'api');
 const sidebarPath = resolve(websiteDir, 'sidebars.js');
@@ -15,10 +16,12 @@ const sidebarTmpPath = resolve(websiteDir, 'sidebars.tmp.js');
 copyFileSync(sidebarPath, sidebarTmpPath);
 writeFileSync(sidebarPath, `module.exports = {};`, { encoding: 'utf8' });
 
-let dirs = readdirSync(packagesDir);
+let packagesList = readdirSync(packagesDir);
+let modulesList = readdirSync(modulesDir);
 
 // Do not build the docs for these packages
-const excludeDirs = ['database-tests', 'e2e', 'error', 'types'];
+const excludePackages = ['database-tests', 'e2e', 'error', 'types'];
+const excludeModules = ['magic-link', 'password'];
 
 const app = new Application();
 
@@ -34,29 +37,29 @@ app.bootstrap({
 });
 
 // Do not build the docs for these packages
-dirs = dirs.filter((dir) => !excludeDirs.includes(dir));
+packagesList = packagesList.filter((dir) => !excludePackages.includes(dir));
+modulesList = modulesList.filter((dir) => !excludeModules.includes(dir));
 
-dirs.forEach((dir) => {
+[
+  ...packagesList.map((dir) => [packagesDir, dir]),
+  ...modulesList.map((dir) => [modulesDir, dir]),
+].forEach(([path, dir]) => {
   // Generate the api doc for each package
-  app.generateDocs(
-    app.expandInputFiles([resolve(packagesDir, dir, 'src')]),
-    resolve(apiDocsDir, dir)
-  );
+  app.generateDocs(app.expandInputFiles([resolve(path, dir, 'src')]), resolve(apiDocsDir, dir));
 
   // We move the generated sidebar into the good API folder so they can be reused when the sidebar is generated
   renameSync(sidebarPath, resolve(apiDocsDir, dir, 'sidebars.js'));
 });
 
 // This is a fix for a generics issue, see https://github.com/tom-grey/typedoc-plugin-markdown/issues/119
-const filePath = resolve(apiDocsDir, 'graphql-api', 'globals.md');
-let fileContent = readFileSync(filePath, {
-  encoding: 'utf8',
-});
-fileContent = fileContent.replace(
-  '= new GraphQLModule<CoreAccountsModuleConfig>',
-  '= new GraphQLModule'
-);
-writeFileSync(filePath, fileContent, { encoding: 'utf8' });
+for (const packageName of readdirSync(apiDocsDir)) {
+  const filePath = resolve(apiDocsDir, packageName, 'globals.md');
+  let fileContent = readFileSync(filePath, {
+    encoding: 'utf8',
+  });
+  fileContent = fileContent.replace(/</g, '‹').replace(/>/g, '›');
+  writeFileSync(filePath, fileContent, { encoding: 'utf8' });
+}
 
 // We restore the sidebar file.
 renameSync(sidebarTmpPath, sidebarPath);

website/sidebars.js

@@ -1,17 +1,23 @@
 // @ts-check
-const { readdirSync } = require('fs');
+const { readdirSync, existsSync } = require('fs');
 const { resolve } = require('path');
 
 const packagesDir = resolve(__dirname, '..', 'packages');
+const modulesDir = resolve(__dirname, '..', 'modules');
 const apiDocsDir = resolve(__dirname, '..', 'website', 'docs', 'api');
 
 const dirs = readdirSync(apiDocsDir);
 
 /** @type any */
 const generatedApi = {};
 
+function resolvePackage(dir) {
+  let path = resolve(packagesDir, dir, 'package.json');
+  return existsSync(path) ? path : resolve(modulesDir, dir, 'package.json');
+}
+
 dirs.forEach((dir) => {
-  const packageName = require(resolve(packagesDir, dir, 'package.json')).name;
+  const packageName = require(resolvePackage(dir)).name;
   const generatedSidebar = require(resolve(apiDocsDir, dir, 'sidebars'));
   generatedApi[packageName] = [];
   if (Object.keys(generatedSidebar.docs).length > 0) {