Releases: peterpeterparker/tsdoc-markdown
Releases · peterpeterparker/tsdoc-markdown
v0.6.0
Features
- Generate jsDoc
@example
content (#28).
Shout-out to mingtianyihou33 for the contributions! 💪
v0.5.0
v0.4.0
Features
- Enable
strictNullChecks
per default when creating TypeScript compiler program. This allow exporting parameters and results that unionsnull
orundefined
.
For example:
/**
* Markdown should handle ` | ` for the type.
*/
export const genericType = <T>(value: [] | [T]): T | undefined => value?.[0];
Previously did not parsed the result | undefined
in the resulting documentation.
v0.3.0
Features
- Add support for jsDocs in Interfaces when generating markdown.
v0.2.1
Fix
- Remove backtick for the description of the Interfaces in generated markdown content.
v0.2.0
Features
- Support for generating documentation for interfaces and types. This new feature is optional and can be enabled using the build options
--types
.
v0.1.0
Features
- upgrade to
typescript@^5
(#13)
Docs
- use
all-contributors
do showcase contributors on README (#15)
Build
- release to npm from CI with provenance flag
Shout-out to mia-riezebos for the contributions! 💪
v0.0.4
v0.0.3
Breaking Changes
- provide the links to the source code in the
json
output as well (#11)
Fix
- use relative path to generate links (#10)
Because this release aim to provide the links to the source code in the outputed JSON file as well, the configuration has to be change.
i.e. the repo URL is not a MarkdownOptions
anymore but, a BuildOptions
generateDocumentation({
inputFiles: utilsInputFiles,
outputFile: './packages/utils/YOLO.md',
buildOptions: {
explore: true,
repo: {
url: 'https://github.com/peterpeterparker/tsdoc-markdown'
}
}
});
v0.0.2
Features
Docs
- display a note about the limitation regarding
Types
andInterfaces
(#6)
Build
- bump dev dependencies
Generating links is an optional feature as it requires the knowledge of the repository URL to which the links should point. If you are using the provided script, you can pass the URL using the --repo
parameter. Alternatively, when using the code, you can provide the repository URL through the MarkdownOptions
object.
generateDocumentation({
inputFiles: utilsInputFiles,
outputFile: './packages/utils/YOLO.md',
buildOptions: {explore: true},
markdownOptions: {
repo: {
url: 'https://github.com/peterpeterparker/tsdoc-markdown'
}
}
});