Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@geut/apiness

Package Overview
Dependencies
Maintainers
5
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@geut/apiness

Generate markdown documentation based on TS Inference and JSDoc.

  • 0.0.9
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
5
Weekly downloads
 
Created
Source

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

Keywords

FAQs

Package last updated on 11 Jun 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc