diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 809ef22..0c65255 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,19 +1,9 @@ -@time-loop/cdk-log-parser +**@time-loop/cdk-log-parser** • **Docs** -# @time-loop/cdk-log-parser - -## Table of contents +*** -### Functions - -- [run](README.md#run) +# @time-loop/cdk-log-parser ## Functions -### run - -▸ **run**(): `void` - -#### Returns - -`void` +- [run](functions/run.md) diff --git a/docs/functions/run.md b/docs/functions/run.md new file mode 100644 index 0000000..136c21d --- /dev/null +++ b/docs/functions/run.md @@ -0,0 +1,13 @@ +[**@time-loop/cdk-log-parser**](../README.md) • **Docs** + +*** + +[@time-loop/cdk-log-parser](../README.md) / run + +# Function: run() + +> **run**(): `void` + +## Returns + +`void` diff --git a/package.json b/package.json index 93c4c75..0fb03cf 100644 --- a/package.json +++ b/package.json @@ -50,7 +50,7 @@ "ts-jest": "^29.1.2", "ts-node": "^10", "typedoc": "^0.25.12", - "typedoc-plugin-markdown": "^3.17.1", + "typedoc-plugin-markdown": "^4.0.0", "typescript": "^5.4.4" }, "dependencies": { diff --git a/yarn.lock b/yarn.lock index 60acb46..87f7290 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6437,12 +6437,10 @@ typedarray@^0.0.6: resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777" integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA== -typedoc-plugin-markdown@^3.17.1: - version "3.17.1" - resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz#c33f42363c185adf842f4699166015f7fe0ed02b" - integrity sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw== - dependencies: - handlebars "^4.7.7" +typedoc-plugin-markdown@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.0.0.tgz#3e6dcfd5fab0f7634c26a71bfbd2cb4fac0b6d18" + integrity sha512-7cNKIGxGq1w9IvwWbm6jAASUCvlJeaANJXCOH+Fcvz2JrNIIMVbRu4j2Nq2zpDDaBHsrUmKVaz+F5vroMU8u4A== typedoc@^0.25.12: version "0.25.12"