npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@geut/apiness

v0.0.9

Published

Generate markdown documentation based on TS Inference and JSDoc.

Downloads

14

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

geutusergeutuserthe-real-dkthe-real-dktinchoz49tinchoz49estebanprimostestebanprimost

Keywords

jsdoctsdocapigeneratormarkdown

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