moving typedoc theme to docs dir, and setting up GH actions

chanind · Dec 30, 2023 · 4043108 · 4043108
1 parent 16cdc1d
commit 4043108
Show file tree

Hide file tree

Showing 27 changed files with 38 additions and 399 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -11,6 +11,12 @@ jobs:
       - run: yarn install
       - run: yarn test
       - run: yarn build
+      - name: Install docs dependencies
+        run: yarn install
+        working-directory: ./docs
+      - name: Build docs
+        run: yarn build
+        working-directory: ./docs
   release:
     needs: lint_test_and_build
     permissions:
@@ -32,3 +38,14 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx semantic-release
+      - name: Install docs dependencies
+        run: yarn install
+        working-directory: ./docs
+      - name: Build docs
+        run: yarn build
+        working-directory: ./docs
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
@@ -75,13 +75,9 @@ const config: Config = {
         {
           // title: 'Docs',
           items: [
-            {
-              label: 'Home',
-              to: '/',
-            },
             {
               label: 'Docs',
-              to: '/docs/intro',
+              to: '/',
             },
           ],
         },

diff --git a/docs/package.json b/docs/package.json
@@ -12,7 +12,8 @@
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
-    "typecheck": "tsc"
+    "typecheck": "tsc",
+    "generate-api": "typedoc ../src --out generated"
   },
   "dependencies": {
     "@docusaurus/core": "3.0.1",
@@ -27,7 +28,10 @@
     "@docusaurus/module-type-aliases": "3.0.1",
     "@docusaurus/tsconfig": "3.0.1",
     "@docusaurus/types": "3.0.1",
-    "typescript": "~5.2.2"
+    "typescript": "~5.2.2",
+    "typedoc": "0.25.4",
+    "typedoc-plugin-markdown": "3.17.1",
+    "typedoc-plugin-no-inherit": "^1.4.0"
   },
   "browserslist": {
     "production": [
@@ -43,5 +47,17 @@
   },
   "engines": {
     "node": ">=18.0"
+  },
+  "typedocOptions": {
+    "excludePrivate": true,
+    "entryPointStrategy": "expand",
+    "exclude": "**/*.spec.ts",
+    "theme": "simple-mdx",
+    "tsconfig": "../tsconfig.json",
+    "plugin": [
+      "typedoc-plugin-no-inherit",
+      "typedoc-plugin-markdown",
+      "./typedoc-simple-mdx-theme/theme.js"
+    ]
   }
 }
diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css
@@ -35,7 +35,7 @@
   font-weight: 400;
   opacity: 0.5;
   margin-top: 1rem;
-  padding: var(--ifm-menu-link-padding-vertical) 0;
+  padding: var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal);
 }
 
 .light-image-bg {

diff --git a/docs/static/img/docusaurus-social-card.jpg b/docs/static/img/docusaurus-social-card.jpg
diff --git a/docs/static/img/docusaurus.png b/docs/static/img/docusaurus.png
diff --git a/docs/static/img/favicon.ico b/docs/static/img/favicon.ico
diff --git a/docs/static/img/logo.svg b/docs/static/img/logo.svg