Added typedoc / reference docs

.gitignore

@@ -3,3 +3,4 @@ node_modules
 .DS_Store
 .git
 .idea
+src/pages/docs/reference

.npmrc

@@ -0,0 +1 @@
+enable-pre-post-scripts=true

README.md

@@ -18,6 +18,10 @@ First, run `pnpm i` to install the dependencies.
 
 Then, run `pnpm dev` to start the development server and visit localhost:3000.
 
+## Typedoc generation
+
+Run `pnpm run typedoc:generate` to generate reference documentation from the framework's typedoc.
+
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.

generate-reference-meta.mjs

@@ -0,0 +1,54 @@
+import fs from "fs";
+const references = fs
+  .readdirSync("./src/pages/docs/reference")
+  .filter((reference) =>
+    fs.lstatSync(`./src/pages/docs/reference/${reference}`).isDirectory()
+  );
+
+const sidebarTitles = {
+  README: "Overview",
+  classes: "Classes",
+  functions: "Functions",
+  interfaces: "Interfaces",
+  "type-aliases": "Type Aliases",
+  globals: "Globals",
+  variables: "Variables",
+};
+
+function categoryToSidebarTitle(category) {
+  return sidebarTitles[category];
+}
+
+function referenceToSidebarTitle(reference) {
+  return `@proto-kit/${reference}`;
+}
+
+console.log("generating typedoc meta files...");
+
+references.forEach((reference) => {
+  const metaTsxPath = `./src/pages/docs/reference/${reference}/_meta.tsx`;
+  fs.rmSync(metaTsxPath, { force: true });
+
+  const categories = fs.readdirSync(
+    `./src/pages/docs/reference/${reference}`,
+    "utf8"
+  );
+
+  const metaTsx = `export default {
+  ${categories.map((category) => {
+    category = category.replace(".md", "");
+    return `"${category}": "${categoryToSidebarTitle(category) ?? category}"`;
+  })}
+};`;
+
+  fs.writeFileSync(metaTsxPath, metaTsx);
+});
+
+const metaTsxPath = `./src/pages/docs/reference/_meta.tsx`;
+const metaTsx = `export default {
+  ${references.map((reference) => {
+    return `"${reference}": "${referenceToSidebarTitle(reference)}"`;
+  })}
+};`;
+
+fs.writeFileSync(metaTsxPath, metaTsx);

generate-typedoc.sh

@@ -0,0 +1,22 @@
+# needs to be cloned to a one-up directory, otherwise README.md auto-discovery
+# in framework's typedoc includes website's README.md, which is not desired
+REPO=$(pwd)
+: "${FRAMEWORK_TYPEDOC_FOLDER:=./../framework-typedoc}"
+: "${FRAMEWORK_BRANCH:=develop}"
+: "${WEBSITE_REFERENCE_DOCS:=./src/pages/docs/reference/}"
+echo "Generating typedoc for framework branch \"$FRAMEWORK_BRANCH\" in \"$FRAMEWORK_TYPEDOC_FOLDER\"";
+rm -rf $FRAMEWORK_TYPEDOC_FOLDER
+git clone https://github.com/proto-kit/framework.git $FRAMEWORK_TYPEDOC_FOLDER
+cd "$FRAMEWORK_TYPEDOC_FOLDER"
+git checkout $FRAMEWORK_BRANCH
+npm ci --force
+npm run prisma:generate
+npm run build
+npm run typedoc
+cd $REPO
+rm -rf $WEBSITE_REFERENCE_DOCS
+mkdir -p $WEBSITE_REFERENCE_DOCS
+cp -r "$FRAMEWORK_TYPEDOC_FOLDER/docs/@proto-kit/." $WEBSITE_REFERENCE_DOCS
+node generate-reference-meta.mjs
+rm -rf $FRAMEWORK_TYPEDOC_FOLDER
+echo "Typedoc generated successfully"

next.config.mjs

@@ -0,0 +1,14 @@
+import nextra from "nextra";
+
+const withNextra = nextra({
+  theme: "nextra-theme-docs",
+  themeConfig: "./theme.config.tsx",
+  latex: true,
+  search: {
+    codeblocks: false,
+  },
+});
+
+export default withNextra({
+  reactStrictMode: true,
+});

package.json

@@ -2,6 +2,8 @@
   "name": "@protokit/website",
   "version": "0.0.1",
   "scripts": {
+    "postinstall": "pnpm run typedoc:generate",
+    "typedoc:generate": "./generate-typedoc.sh",
     "dev": "next dev",
     "build": "next build",
     "start": "next start"
@@ -51,8 +53,8 @@
     "lucide-react": "^0.279.0",
     "next": "^13.4.0",
     "next-themes": "^0.2.1",
-    "nextra": "^2.0.0",
-    "nextra-theme-docs": "^2.0.0",
+    "nextra": "3",
+    "nextra-theme-docs": "3",
     "node-fetch": "2.6.1",
     "react": "^18.2.0",
     "react-day-picker": "^8.8.2",
@@ -61,10 +63,12 @@
     "react-youtube": "^10.1.0",
     "tailwind-merge": "^1.14.0",
     "tailwindcss-animate": "^1.0.7",
+    "typedoc": "^0.27.6",
     "zod": "^3.22.2"
   },
   "devDependencies": {
     "@types/node": "18.11.10",
+    "@types/react": "19.0.8",
     "autoprefixer": "^10.4.16",
     "postcss": "^8.4.31",
     "tailwindcss": "^3.3.3",