docs: ship TSDoc config (#453)

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.npmignore

@@ -157,14 +157,14 @@ dist
 !/dist/
 !/dist.*/
 
-# TypeScript source files are intended to be shipped,
-# as they can provide additional context for downstream users.
-# The compiler configs are shipped, so downstream users can inherit from them.
-# The TypeDoc configs are shipped, so downstream users can generate API documentation with them.
+# TypeScript source files are intended to be shipped, as they can provide additional context for downstream users.
+# The TSCompiler configs are shipped, so downstream users can inherit from them.
+# The TypeDoc & TSDoc configs are shipped, so downstream users can generate API documentation with them.
 !/src/
 !/tsconfig.*
 !/webpack.*
 !/typedoc.*
+!/tsdoc.json
 
 /test/
 /tests/

HISTORY.md

@@ -5,9 +5,10 @@ All notable changes to this project will be documented in this file.
 ## unreleased
 
 * Docs
-  * Use [TSDoc](https://tsdoc.org/) syntax in TypeScript files, instead of [JSDoc](https://jsdoc.app/) (via [#318])
+  * Use [TSDoc](https://tsdoc.org/) syntax in TypeScript files, instead of [JSDoc](https://jsdoc.app/) (via [#318], [#453])
 
 [#318]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/318
+[#453]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/453
 
 ## 1.10.0 - 2023-01-28