jest-runner-docs
Jest runner for API documentation generation from code comments, supports TypeScript. Very stable and reliable, based on parse-comments
package
Please consider following this project's author,
Charlike Mike Reagent, and :star: the project
to show your :heart: and support.
If you have any how-to kind of questions, please read the Contributing
Guide and Code of Conduct documents.
For bugs reports and feature requests, please create an issue
or ping @tunnckoCore at Twitter.
Project is semantically versioned & automatically released
from GitHub Actions with
Lerna.
Topic | Contact |
---|
Any legal or licensing questions, like private or commerical use | |
For any critical problems and security reports | |
Consulting, professional support, personal or team training | |
For any questions about Open Source, partnerships and sponsoring | |
Table of Contents
(TOC generated by verb using markdown-toc)
Install
This project requires Node.js >=10.13
(see
Support & Release Policy).
Install it using yarn or
npm.
We highly recommend to use Yarn when you
think to contribute to this project.
$ yarn add jest-runner-docs
API
back to top
Contributing
Guides and Community
Please read the Contributing Guide and Code of
Conduct documents for advices.
For bug reports and feature requests, please join our community
forum and open a thread there with prefixing the title of the thread with the
name of the project if there's no separate channel for it.
Consider reading the
Support and Release Policy
guide if you are interested in what are the supported Node.js versions and how
we proceed. In short, we support latest two even-numbered Node.js release lines.
Support the project
Become a Partner or Sponsor? :dollar: Check the OpenSource
Commision (tier). :tada: You can get your company logo, link & name on this
file. It's also rendered on package's page in npmjs.com and
yarnpkg.com sites too! :rocket:
Not financial support? Okey!
Pull requests,
stars and all kind of
contributions
are always welcome. :sparkles:
Contributors
This project follows the
all-contributors
specification. Contributions of any kind are welcome!
Thanks goes to these wonderful people
(emoji key), consider showing
your support to them:
back to top
License
Copyright (c) 2019-present,
Charlike Mike Reagent <opensource@tunnckocore.com>
& contributors.
Released under the
MPL-2.0 License.