feat: add Messenger API docs site with local search

Docusaurus site for browsing controller messenger actions/events,
with offline search powered by docusaurus-search-local.

Author: cryptodev-2s

.github/workflows/messenger-docs.yml

@@ -0,0 +1,63 @@
+name: Messenger API Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  build-docs:
+    name: Build Messenger API docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout and setup environment
+        uses: MetaMask/action-checkout-and-setup@v2
+        with:
+          is-high-risk-environment: false
+
+      - name: Generate Messenger docs
+        run: yarn docs:messenger:generate
+
+      - name: Install docs-site dependencies
+        run: npm --prefix docs-site install
+
+      - name: Build Docusaurus site
+        run: npm --prefix docs-site run build
+
+      - name: Upload build artifact (PR)
+        if: github.event_name == 'pull_request'
+        uses: actions/upload-artifact@v4
+        with:
+          name: messenger-api-docs
+          path: docs-site/build/
+          retention-days: 7
+
+      - name: Upload Pages artifact (main)
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs-site/build/
+
+  deploy:
+    name: Deploy to GitHub Pages
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    needs: build-docs
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -37,6 +37,14 @@ scripts/coverage
 # typescript
 packages/*/*.tsbuildinfo
 
+# Messenger API docs site (generated)
+docs-site/docs/
+docs-site/sidebars.ts
+docs-site/build/
+docs-site/.docusaurus/
+docs-site/node_modules/
+docs-site/package-lock.json
+
 # Emacs
 \#*\#
 .#*

docs-site/docusaurus.config.ts

@@ -0,0 +1,97 @@
+import type * as Preset from '@docusaurus/preset-classic';
+import type { Config } from '@docusaurus/types';
+import { themes } from 'prism-react-renderer';
+
+const codeTheme = themes.dracula;
+
+const config: Config = {
+  title: 'MetaMask Core Messenger API',
+  tagline: 'Action and event reference for the MetaMask controller messenger',
+  url: 'https://metamask.github.io',
+  baseUrl: '/core/',
+  favicon: 'img/favicons/favicon-96x96.png',
+
+  onBrokenLinks: 'warn',
+
+  markdown: {
+    hooks: {
+      onBrokenMarkdownLinks: 'warn',
+    },
+  },
+
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  themes: [
+    [
+      '@easyops-cn/docusaurus-search-local',
+      {
+        docsRouteBasePath: '/',
+        hashed: true,
+        indexBlog: false,
+        highlightSearchTermsOnTargetPage: true,
+      },
+    ],
+  ],
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          routeBasePath: '/',
+          sidebarPath: './sidebars.ts',
+          breadcrumbs: false,
+        },
+        blog: false,
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    colorMode: {
+      respectPrefersColorScheme: true,
+    },
+    navbar: {
+      logo: {
+        alt: 'MetaMask logo',
+        src: 'img/metamask-logo.svg',
+        srcDark: 'img/metamask-logo-dark.svg',
+      },
+      hideOnScroll: false,
+      items: [
+        {
+          href: 'https://github.com/MetaMask/core',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    docs: {
+      sidebar: {
+        autoCollapseCategories: false,
+      },
+    },
+    footer: {
+      logo: {
+        alt: 'MetaMask logo',
+        src: 'img/metamask-logo.svg',
+        srcDark: 'img/metamask-logo-dark.svg',
+        href: 'https://metamask.io/',
+      },
+      copyright: `\u00a9 ${new Date().getFullYear()} MetaMask \u2022 A Consensys Formation`,
+    },
+    prism: {
+      theme: codeTheme,
+      defaultLanguage: 'typescript',
+      additionalLanguages: ['bash', 'json'],
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;

docs-site/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "messenger-api-docs",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "build": "docusaurus build",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve",
+    "start": "docusaurus start"
+  },
+  "dependencies": {
+    "@docusaurus/core": "^3.9.0",
+    "@docusaurus/preset-classic": "^3.9.0",
+    "@easyops-cn/docusaurus-search-local": "^0.55.0",
+    "prism-react-renderer": "^2.4.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "devDependencies": {
+    "@docusaurus/types": "^3.9.0",
+    "typescript": "~5.3.3"
+  },
+  "engines": {
+    "node": ">=18.0"
+  }
+}