diff --git a/.github/workflows/deploy-docs-to-pages.yml b/.github/workflows/deploy-docs-to-pages.yml index e0a3cd1..95565b5 100644 --- a/.github/workflows/deploy-docs-to-pages.yml +++ b/.github/workflows/deploy-docs-to-pages.yml @@ -44,7 +44,7 @@ jobs: run: yarn install - name: Install typedoc - run: yarn add -D typedoc@0.26.11 + run: yarn add -D typedoc@0.26.11 typedoc-plugin-include-example@1.4.1 - name: Build run: yarn typedoc diff --git a/src/index.ts b/src/index.ts index 44fb540..ec1f110 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,4 +1,6 @@ /** + * @includeExample example/main.js + * * @module API */ diff --git a/typedoc.json b/typedoc.json index 1005dd4..026da77 100644 --- a/typedoc.json +++ b/typedoc.json @@ -9,4 +9,7 @@ "excludeReferences": true, "out": "./docs/html", "projectDocuments": ["docs/documents/*.md"], + "plugin": [ + "typedoc-plugin-include-example" + ] }