From 42e8baf2d9abccfc770aa8ecab376ae92cf32943 Mon Sep 17 00:00:00 2001 From: Jason Williscroft Date: Thu, 14 Nov 2024 11:09:39 +0800 Subject: [PATCH] updated docs --- docs/functions/index.foo.html | 2 +- docs/index.html | 2 +- docs/modules/index.html | 2 +- docs/sitemap.xml | 27 +++++++++++++++++++++++++++ docs/types/index.FooTarget.html | 2 +- typedoc.json | 1 + 6 files changed, 32 insertions(+), 4 deletions(-) create mode 100644 docs/sitemap.xml diff --git a/docs/functions/index.foo.html b/docs/functions/index.foo.html index 0d2ec68..34619a4 100644 --- a/docs/functions/index.foo.html +++ b/docs/functions/index.foo.html @@ -6,4 +6,4 @@

See

TSDoc for more info!

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 42f2438..b1b0c60 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -@karmaniverous/npm-package-template-ts

@karmaniverous/npm-package-template-ts

TypeScript NPM Package Template

Writing great TypeScript is only half the battle! You also need to instrument it, format it, lint it, test it, bundle it, document it, and publish it!

+@karmaniverous/npm-package-template-ts

@karmaniverous/npm-package-template-ts

TypeScript NPM Package Template

Writing great TypeScript is only half the battle! You also need to instrument it, format it, lint it, test it, bundle it, document it, and publish it!

Getting all of these pieces to work gracefully together is not trivial.

This template puts those pieces together in a way that just WORKS, right out of the box, so you can focus on your code. It includes fully-configured support for:

✅ Code authoring with TypeScript.
diff --git a/docs/modules/index.html b/docs/modules/index.html index 4f3fb06..22064e1 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ index | @karmaniverous/npm-package-template-ts

Module index

This is the main entry point for the library.

-

Index

Type Aliases

FooTarget +

Index

Type Aliases

FooTarget

Functions

foo

Settings

Member Visibility
diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 0000000..64111bd --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,27 @@ + + + + https://docs.karmanivero.us/npm-package-template-ts/modules.html + 2024-11-14T03:09:29.494Z + + + https://docs.karmanivero.us/npm-package-template-ts/index.html + 2024-11-14T03:09:29.494Z + + + https://docs.karmanivero.us/npm-package-template-ts/documents/CHANGELOG.html + 2024-11-14T03:09:29.494Z + + + https://docs.karmanivero.us/npm-package-template-ts/modules/index.html + 2024-11-14T03:09:29.494Z + + + https://docs.karmanivero.us/npm-package-template-ts/types/index.FooTarget.html + 2024-11-14T03:09:29.494Z + + + https://docs.karmanivero.us/npm-package-template-ts/functions/index.foo.html + 2024-11-14T03:09:29.494Z + + diff --git a/docs/types/index.FooTarget.html b/docs/types/index.FooTarget.html index b7f827f..35bd5d3 100644 --- a/docs/types/index.FooTarget.html +++ b/docs/types/index.FooTarget.html @@ -1,2 +1,2 @@ FooTarget | @karmaniverous/npm-package-template-ts

Type Alias FooTarget

FooTarget: string | undefined

The kind of thing you could foo.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/typedoc.json b/typedoc.json index e98f10b..8f5a1e3 100644 --- a/typedoc.json +++ b/typedoc.json @@ -13,6 +13,7 @@ "tsx", "typescript" ], + "hostedBaseUrl": "https://docs.karmanivero.us/npm-package-template-ts", "out": "./docs/", "plugin": ["typedoc-plugin-mdn-links", "typedoc-plugin-replace-text"], "projectDocuments": ["./CHANGELOG.md"],