docs: Introduce Typedoc (inikulin#443)

jmbpwtw · Feb 16, 2023 · a6d7da0 · a6d7da0
1 parent f2b0779
commit a6d7da0
Show file tree

Hide file tree

Showing 4 changed files with 226 additions and 4 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -0,0 +1,25 @@
+name: Deploy to GitHub Pages
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    deploy:
+        name: Deploy to GitHub Pages
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: lts/*
+                  cache: npm
+            - run: npm ci
+            - name: Build docs
+              run: npm run build:docs
+            - name: Deploy
+              uses: peaceiris/actions-gh-pages@v3
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  publish_dir: docs/build
+                  cname: parse5.js.org
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -21,12 +21,14 @@
         "prettier": "^2.5.0",
         "ts-jest": "^27.1.3",
         "ts-node": "^10.7.0",
+        "typedoc": "^0.22.13",
         "typescript": "^4.6.2"
     },
     "scripts": {
         "build": "npm run build:esm && npm run build:cjs",
         "build:esm": "tsc --build packages/* test",
         "build:cjs": "tsc -p packages/parse5/tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > packages/parse5/dist/cjs/package.json",
+        "build:docs": "typedoc .",
         "prettier": "prettier '**/*.{js,ts,md,json,yml}' --loglevel warn",
         "format": "npm run format:es && npm run format:prettier",
         "format:es": "npm run lint:es -- --fix",