@geut/apiness

Generate markdown documentation based on TS Inference and JSDoc.

Usage no npm install needed!

<script type="module">
  import geutApiness from 'https://cdn.skypack.dev/@geut/apiness';
</script>

README

apiness

Generate markdown documentation based on TS Inference and JSDoc.

Build Status JavaScript Style Guide standard-readme compliant

Made by GEUT

Install

$ npm install -g @geut/apiness

Usage

  1. Define the marks where the documentation API should be added in the README file. apiness defines 3 marks:
  • <!-- apiness/intro -->: For @packageDocumentation tag.
  • <!-- apiness/usage -->: For module @examples tag.
  • <!-- apiness/api -->: For Statement Type Definitions by TS Inference and/or JSDoc.
<!-- apiness/intro -->

## Usage

<!-- apiness/usage -->

## API

<!-- apiness/api -->
  1. Document your code.
  2. Run: apiness <entry>

Issues

:bug: If you found an issue we encourage you to report it on github. Please specify your OS and the actions to reproduce it.

Contributing

:busts_in_silhouette: Ideas and contributions to the project are welcome. You must follow this guideline.

License

MIT © A GEUT project