Skip to content

v0.0.2

Compare
Choose a tag to compare
@peterpeterparker peterpeterparker released this 02 Jul 11:03
· 60 commits to main since this release

Features

  • generate links to the documented source code (#5)
  • ignore constructors without documentation (#4)

Docs

  • display a note about the limitation regarding Types and Interfaces (#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'
    }
  }
});