Skip to content

[DOCS]: inject API description to readme from TSDoc comments #17

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
Closed
2 of 3 tasks
sergey-s-betke opened this issue Nov 6, 2024 · 16 comments
Closed
2 of 3 tasks

[DOCS]: inject API description to readme from TSDoc comments #17

sergey-s-betke opened this issue Nov 6, 2024 · 16 comments
Assignees
@sergey-s-betke
Labels
released Status: Triage Type: Documentation Improvements or additions to documentation

Comments

@sergey-s-betke
Copy link
Contributor

sergey-s-betke commented Nov 6, 2024 •
edited
Loading

Describe the need

  • Inject API description to readme from TSDoc comments
    • for GitHub
    • for npm package registry

Code of Conduct

  • I agree to follow this project's Code of Conduct
@sergey-s-betke sergey-s-betke added Type: Documentation Improvements or additions to documentation Status: Triage labels Nov 6, 2024
@sergey-s-betke sergey-s-betke self-assigned this Nov 6, 2024
@sergey-s-betke
Copy link
Contributor Author

https://www.npmjs.com/package/tsdoc-markdown

@sergey-s-betke
Copy link
Contributor Author

https://dev.to/austingil/3-ways-to-write-function-overloads-with-jsdoc-typescript-22ca

@sergey-s-betke
Copy link
Contributor Author

https://tsdoc.org/pages/tags/example/

@sergey-s-betke
Copy link
Contributor Author

https://tsdoc.org/pages/tags/inheritdoc/

@sergey-s-betke
Copy link
Contributor Author

https://tsdoc.org/pages/tags/packagedocumentation/

@sergey-s-betke
Copy link
Contributor Author

microsoft/TypeScript#25590

@sergey-s-betke
Copy link
Contributor Author

https://typedoc.org/tags/overload/

sergey-s-betke added a commit that referenced this issue Nov 6, 2024
@sergey-s-betke
docs: inject API description to readme from TSDoc comments
890a8d6 
Fixes #17
@sergey-s-betke
Copy link
Contributor Author

https://www.npmjs.com/package/typedoc-plugin-markdown

@sergey-s-betke
Copy link
Contributor Author

https://github.com/typedoc2md/typedoc-plugin-markdown-examples/blob/main/.github/workflows/ci.wiki.yml

@sergey-s-betke
Copy link
Contributor Author

https://habr.com/ru/companies/docsvision/articles/341562/

@sergey-s-betke
Copy link
Contributor Author

typedoc2md/typedoc-plugin-markdown#577

@sergey-s-betke
Copy link
Contributor Author

https://plugin-md-enhance.vuejs.press/guide/content/include.html#syntax

@sergey-s-betke
Copy link
Contributor Author

sergey-s-betke commented Nov 6, 2024 •
edited
Loading

https://learn.microsoft.com/en-us/contribute/content/markdown-reference
https://learn.microsoft.com/en-us/contribute/content/markdown-reference#includes-syntax

@sergey-s-betke sergey-s-betke linked a pull request Nov 23, 2024 that will close this issue
Add full support for old interface, more examples #24
Merged
4 tasks
sergey-s-betke added a commit that referenced this issue Nov 23, 2024
@sergey-s-betke
docs: inject API description to readme from TSDoc comments
bb0ba53 
Fixes #17
@github-actions GitHub Actions
Copy link

🎉 This issue has been resolved in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@sergey-s-betke sergey-s-betke removed a link to a pull request Nov 24, 2024
Add full support for old interface, more examples #24
Merged
4 tasks
@sergey-s-betke
Copy link
Contributor Author

https://api-extractor.com/pages/setup/generating_docs/

sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API manual generator
b0a1ecd 
Build API description with api-extractor and api-documenter.

Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API manual generator
5421d8d 
Build API description with api-extractor and api-documenter.

Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API manual generator
d222a12 
Build API description with api-extractor and api-documenter.

Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API docs updating to GitHub workflow
35ddc45 
Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API docs updating to GitHub workflow
2c65596 
Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API docs updating to GitHub workflow
07bfba9 
Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API docs updating to GitHub workflow
6f8dbcc 
Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API docs updating to GitHub workflow
a001662 
Fixes #17
@sergey-s-betke sergey-s-betke mentioned this issue Nov 26, 2024
Merged
4 tasks
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API manual generator
1ab99f7 
Build API description with api-extractor and api-documenter.

Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API docs updating to GitHub workflow
8b321ff 
Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
fix: add API manual generator
4120420 
Build API description with api-extractor and api-documenter.

Fixes #17
sergey-s-betke added a commit that referenced this issue Nov 26, 2024
@sergey-s-betke
ci: add API docs updating to GitHub workflow
b7d8e12 
Fixes #17
github-actions bot pushed a commit that referenced this issue Nov 26, 2024
@semantic-release-bot
chore(release): 3.0.1 [skip ci]
9d112db 
## [3.0.1](v3.0.0...v3.0.1) (2024-11-26)

### Bug Fixes

* add API manual generator ([4120420](4120420)), closes [#17](#17)

### Other Updates

* add API docs updating to GitHub workflow ([b7d8e12](b7d8e12)), closes [#17](#17)
* **deps:** bump @arethetypeswrong/cli from 0.16.4 to 0.17.0 ([2b5d645](2b5d645))
* **deps:** bump eslint-plugin-tsdoc from 0.3.0 to 0.4.0 ([88f3361](88f3361))
* **deps:** restore Dependabot ([28122b1](28122b1))
* **github-actions:** publish coverage info ([1470bde](1470bde)), closes [#34](#34)
* **github-actions:** publish tests resuls to GitHub ([099c3da](099c3da)), closes [#33](#33)
* **github-actions:** restore deployment workflow autorun ([b62122e](b62122e))
@github-actions GitHub Actions
Copy link

🎉 This issue has been resolved in version 3.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sergey-s-betke sergey-s-betke

Labels
released Status: Triage Type: Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sergey-s-betke