docs: add nuxt-vuefire to api

Author: posva

docs/.vitepress/config.ts

@@ -129,7 +129,7 @@ export default defineConfig({
 
     nav: [
       { text: 'Guide', link: '/guide/' },
-      { text: 'API', link: '/api/' },
+      { text: 'API', link: '/api/', activeMatch: '^/api/' },
       {
         text: `v${version}`,
         items: [
@@ -180,10 +180,6 @@ function sidebarGuide(): SidebarGroup {
         text: 'Realtime Data',
         link: '/guide/realtime-data',
       },
-      {
-        text: 'Options API',
-        link: '/guide/options-api-realtime-data',
-      },
       {
         text: 'Authentication',
         link: '/guide/auth',
@@ -200,6 +196,10 @@ function sidebarGuide(): SidebarGroup {
         text: 'SSR',
         link: '/guide/ssr',
       },
+      {
+        text: 'Options API',
+        link: '/guide/options-api-realtime-data',
+      },
       // NOTE: hide until it works
       // {
       //   text: 'Querying the database',
@@ -269,12 +269,11 @@ function sidebarCookbook(): SidebarGroup {
 
 function sidebarApi(): SidebarGroup {
   return {
-    text: 'API',
+    text: 'API Reference',
     items: [
-      {
-        text: 'API Reference',
-        link: '/api/',
-      },
+      { text: 'Package List', link: '/api/' },
+      { text: 'nuxt-vuefire', link: '/api/modules/nuxt_vuefire.html' },
+      { text: 'vuefire', link: '/api/modules/vuefire.html' },
     ],
   }
 }

packages/nuxt/src/module.ts

@@ -1,3 +1,6 @@
+/**
+ * @module nuxt-vuefire
+ */
 import { fileURLToPath } from 'node:url'
 import { normalize } from 'node:path'
 import {

scripts/run-typedoc.cjs

@@ -4,9 +4,12 @@ const path = require('node:path')
 createTypeDocApp({
   name: 'API Documentation',
   tsconfig: path.resolve(__dirname, './typedoc.tsconfig.json'),
-  // entryPointStrategy: 'packages',
+  categorizeByGroup: true,
   githubPages: false,
   disableSources: true, // some links are in node_modules and it's ugly
   plugin: ['typedoc-plugin-markdown'],
-  entryPoints: [path.resolve(__dirname, '../src/index.ts')],
+  entryPoints: [
+    path.resolve(__dirname, '../src/index.ts'),
+    path.resolve(__dirname, '../packages/nuxt/src/module.ts'),
+  ],
 }).build()

scripts/typedoc-markdown.cjs

@@ -41,12 +41,13 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) {
      * @param {import('typedoc/dist/lib/output/events').PageEvent} page
      */
     (page) => {
-      if (page.url !== 'index.md' && page.contents) {
-        page.contents = prependYAML(page.contents, {
-          // TODO: figure out a way to point to the source files?
-          editLink: false,
-        })
+      if (!page.contents) {
+        return
       }
+      page.contents = prependYAML(page.contents, {
+        // TODO: figure out a way to point to the source files?
+        editLink: false,
+      })
     }
   )
 

scripts/typedoc.tsconfig.json

@@ -1,14 +1,19 @@
 {
-  "include": ["../src/**/*.ts"],
-  "exclude": ["**/*.spec.ts"],
+  "include": ["../src/**/*.ts", "../packages/nuxt/src/**/*.ts"],
+  "exclude": [
+    "**/*.spec.ts",
+    "../packages/nuxt/playground",
+    "../packages/nuxt/src/runtime"
+  ],
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": "..",
     "outDir": "dist",
     "sourceMap": false,
     "noEmit": true,
     "paths": {
-      "vuefire": ["../src"]
+      "vuefire": ["../src"],
+      "nuxt-vuefire": ["../packages/nuxt/src/module.ts"]
     },
 
     "target": "esnext",
@@ -30,6 +35,7 @@
     "esModuleInterop": true,
     "removeComments": false,
     "jsx": "preserve",
-    "lib": ["esnext", "dom"]
+    "lib": ["esnext", "dom"],
+    "types": ["node"]
   }
 }

src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module vuefire
+ */
 import type { FirebaseApp } from 'firebase/app'
 import type { App } from 'vue-demi'
 import { _FirebaseAppInjectionKey } from './app'