From 80ddc3d0a1c8bd780c6e1c6db80295a11389d725 Mon Sep 17 00:00:00 2001
From: MultiMote <contact@mmote.ru>
Date: Tue, 19 Nov 2024 23:36:59 +0300
Subject: [PATCH] Example
---
.github/workflows/deploy-docs-to-pages.yml | 2 +-
src/index.ts | 2 ++
typedoc.json | 3 +++
3 files changed, 6 insertions(+), 1 deletion(-)
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"
+ ]
}