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

cdoc

v0.0.3

Published

Simple stupid CoffeeScript documentation extractor

Downloads

14

Readme

CDoc - CoffeeScript documentation extractor

CDoc is a simple NodeJS script that extracts comments from CoffeeScript files in the source directory tree, and creates an identical directory tree in the target directory that contains markdown comments found in source files.

Other than extracting markdown comments, CDoc doesn't do anything. It does not compile HTML, has no templates or CSS. In other words, CDoc is not a documetnation generator.

Installation

Install using npm:

npm install cdoc

Basic usage

To extract documentation located in src directory, and store extracted files in doc:

cdoc src doc

The doc directory will contain the same directory structure as src and all .coffee files in the src directory will have a matching .mkd file in the doc directory.

Ignoring directories

To ignore directories, pass the -i or --ignore option:

cdoc src doc -i test -i example

Reporting bugs

Report all bugs to GitHub issue tracker.