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.

Sign up for GitHub

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

Jump to bottom

Generating API document #26

Open
1 of 4 tasks
Atry opened this issue Jan 14, 2023 · 0 comments · May be fixed by #28
Open
1 of 4 tasks

Generating API document #26

Atry opened this issue Jan 14, 2023 · 0 comments · May be fixed by #28
Labels
enhancement New feature or request

Comments

@Atry
Copy link
Contributor

Atry commented Jan 14, 2023

Feature Request

Is your feature request related to a problem? Please describe.
Usually a library author would like to publish their API document. It would be great if the functionality is available out-of-box.

Describe the solution you'd like

There is a solution to generate API document into README.md, as described at https://stackoverflow.com/a/57052392/955091

Describe alternatives you've considered
Other solutions might be publishing to GitHub Pages, but it would be more complicated for a starter template.

Are you willing to resolve this issue by submitting a Pull Request?

  • Yes, I have the time, and I know how to start.
  • Yes, I have the time, but I don't know how to start. I would need guidance.
  • No, I don't have the time, although I believe I could do it if I had the time...
  • No, I don't have the time and I wouldn't even know how to start.
@Atry Atry added the enhancement New feature or request label Jan 14, 2023
@Atry Atry linked a pull request Jan 16, 2023 that will close this issue
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

build: add scripts to generate API document into README.md Atry/typescript-npm-package-template
1 participant
@Atry