docs(bindings/nodejs): copyright in footer (#3986)

* docs(bindings/nodejs): copyright in footer Signed-off-by: suyanhanx <[email protected]> * fix: header Signed-off-by: suyanhanx <[email protected]> --------- Signed-off-by: suyanhanx <[email protected]>
apache · Jan 15, 2024 · 5628f7c · 5628f7c
1 parent d18782a
commit 5628f7c
Show file tree

Hide file tree

Showing 7 changed files with 103 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -113,6 +113,10 @@ jobs:
         working-directory: bindings/nodejs
         run: pnpm install --frozen-lockfile
 
+      - name: Build docs theme
+        working-directory: bindings/nodejs
+        run: pnpm run build:theme
+
       - name: Build bindings/nodejs Docs
         working-directory: bindings/nodejs
         run: pnpm run docs

diff --git a/bindings/nodejs/package.json b/bindings/nodejs/package.json
@@ -52,6 +52,7 @@
     "@swc-node/register": "^1.6.2",
     "@swc/core": "^1.3.38",
     "@types/node": "^18.14.5",
+    "@types/react": "^18.2.48",
     "benny": "^3.7.1",
     "dotenv": "^16.0.3",
     "prettier": "^2.8.4",
@@ -65,6 +66,7 @@
   "scripts": {
     "build": "napi build --platform --features \"${NAPI_FEATURES:-}\" --target \"${NAPI_TARGET:-}\" --release --js generated.js --dts generated.d.ts && node ./scripts/header.js",
     "build:debug": "napi build --platform --features \"${NAPI_FEATURES:-}\" --target \"${NAPI_TARGET:-}\" --js generated.js --dts generated.d.ts && node ./scripts/header.js",
+    "build:theme": "tsc -p ./tsconfig.theme.json",
     "docs": "typedoc",
     "format": "prettier --write .",
     "test": "vitest",
@@ -75,7 +77,7 @@
   "prettier": {
     "overrides": [
       {
-        "files": "./**/*.{js,ts,mjs}",
+        "files": "./**/*.{js,ts,mjs,jsx,tsx}",
         "options": {
           "arrowParens": "always",
           "parser": "typescript",

diff --git a/bindings/nodejs/pnpm-lock.yaml b/bindings/nodejs/pnpm-lock.yaml
diff --git a/bindings/nodejs/theme/index.tsx b/bindings/nodejs/theme/index.tsx
@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { DefaultTheme, PageEvent, Reflection, Options, DefaultThemeRenderContext, Application, JSX } from 'typedoc'
+
+export class FooterWithASFCopyright extends DefaultThemeRenderContext {
+  constructor(theme: DefaultTheme, page: PageEvent<Reflection>, options: Options) {
+    super(theme, page, options)
+
+    this.footer = () => {
+      return (
+        <>
+          <div class="tsd-generator">
+            <p>
+              Copyright © 2022-2024, The Apache Software Foundation Apache OpenDAL, OpenDAL, Apache, Apache Incubator,
+              the Apache feather, the Apache Incubator logo and the Apache OpenDAL project logo are either registered
+              trademarks or trademarks of the Apache Software Foundation.
+            </p>
+          </div>
+        </>
+      ) as unknown as JSX.Element
+    }
+  }
+}
+
+export class FooterOverrideTheme extends DefaultTheme {
+  private _contextCache?: FooterWithASFCopyright
+
+  override getRenderContext(pageEvent: PageEvent<Reflection>): FooterWithASFCopyright {
+    this._contextCache ||= new FooterWithASFCopyright(this, pageEvent, this.application.options)
+
+    return this._contextCache
+  }
+}
+
+export function load(app: Application) {
+  app.renderer.defineTheme('opendal', FooterOverrideTheme)
+}
diff --git a/bindings/nodejs/tsconfig.json b/bindings/nodejs/tsconfig.json
@@ -10,5 +10,5 @@
     "allowSyntheticDefaultImports": true
   },
   "include": ["."],
-  "exclude": ["node_modules", "benchmark"]
+  "exclude": ["node_modules", "benchmark", "theme"]
 }
diff --git a/bindings/nodejs/tsconfig.theme.json b/bindings/nodejs/tsconfig.theme.json
@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "outDir": "theme/dist",
+
+    "jsx": "react",
+    "jsxFactory": "JSX.createElement",
+    "jsxFragmentFactory": "JSX.Fragment"
+  },
+  "include": ["theme"]
+}
diff --git a/bindings/nodejs/typedoc.json b/bindings/nodejs/typedoc.json
@@ -8,6 +8,8 @@
   "excludeExternals": true,
   "includeVersion": true,
   "githubPages": false,
+  "plugin": ["./theme/dist/index.js"],
+  "theme": "opendal",
   "navigationLinks": {
     "Homepage": "https://opendal.apache.org/",
     "GitHub": "https://github.com/apache/incubator-opendal/tree/main/bindings/nodejs"