Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically generate documentation file using tsdoc #15

Open
fpapado opened this issue Oct 17, 2019 · 1 comment
Open

Automatically generate documentation file using tsdoc #15

fpapado opened this issue Oct 17, 2019 · 1 comment
Assignees

Comments

@fpapado
Copy link
Owner

fpapado commented Oct 17, 2019

Microsoft has tsdoc, which allows extracting comments from the source. It is built with TypeScript in mind.

I'd love a future where we can pull out the documentation and put it into a markdown file.

Potential next steps

  • Try out tsdoc, and parse the files, starting at the index
  • Generate a markdown document for it. There might be a library to do this, but it might also be a script in this repository
  • Integrate a build-docs step in the package.json
@ArtemKolichenkov
Copy link

I can take it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants