diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index e60b083..17b295c 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -29,6 +29,10 @@ jobs: - name: Build demo working-directory: demo run: pnpm build + - name: Generate typedoc + run: pnpm gen:docs + - name: Stage typedoc under demo/dist/docs + run: cp -R docs demo/dist/docs - uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0 - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0 with: diff --git a/.gitignore b/.gitignore index e050d08..04fd153 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ build release dist dist-debug +docs .cache-debug .cache-demo demo/.cache diff --git a/package.json b/package.json index 05dfb59..fec0c09 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,8 @@ "format": "prettier --write .", "format:check": "prettier --check .", "validate": "publint", - "clean": "rm -rf dist", + "clean": "rm -rf dist docs", + "gen:docs": "typedoc", "prepack": "pnpm run build", "prepare": "husky" }, diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..18da066 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,11 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPoints": ["src/index.ts"], + "out": "docs", + "readme": "README.md", + "name": "nf-player", + "excludeExternals": true, + "excludePrivate": true, + "excludeInternal": true, + "githubPages": false +}