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

doccomentation

v1.1.1

Published

A NodeJS plugin that allows JSDoc style comments to be extracted out of a file and either returned as a markdown string or inserted into a target Markdown file. Can also be inserted at a specific location in the target file

Downloads

4

Vulnerabilities

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

Links

Maintainers

tommichitommichi

Keywords

documentationJSDocjsdocmarkdowncommentsjavascriptcssNodeJSNode

Readme

Doccomentation

A NodeJS plugin that allows JSDoc style comments to be extracted out of a file and either returned as a markdown string or inserted into a target Markdown file.

Installation

Can be installed via NPM with the command

npm install doccommentation --save-dev

Support

NodeJS 6+

Command Line

doccomentation --source 'src/**/*.js' --target 'README.md' --header 'API Documentation'

If the package is not installed the command line may not work. You will, however, always be able to run it as an NPM script (the "scripts" section in your package.json).

API Documentation

createMarkdown(params) ⇒ Promise

Creates markdown content from JSDoc comments existing in target files

Kind: global function
Returns: Promise - The markdown string generated from all the source JSDoc comments

Release Notes

v0.8.0

  • Initial release

v0.8.1

  • Add cli

v1.0.0

  • Updated documentation
  • Added unit tests
  • Minor refactoring following addition of unit tests

v1.0.1

  • Updated readme documentation
  • Run unit tests as CI step
  • Automated publication after successfull merge and test on Master

v1.0.2

  • Added reference to Github repository

v1.0.4

  • Updated readme doccumentation and security patches

v1.1.0

  • Fix injection of data into an existing markdown file
  • Some minor refactoring

v1.1.1

  • Minor tweaks to the render function