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

@hn3000/doxic

v0.3.2

Published

Generator for runnable documentation, inspired by docco and jasmine docs.

Downloads

2

Readme

experimental documentation generator

installation (for now):

npm link

doxic -- a Tool for executable docs

Documentation generator inspired by [docco] that allows examples to be run.

Only the parallel template has the required support code for running examples.

What it is about

In order to make the documentation easier to understand, example code can be run directly in the page where it is displayed. If it makes sense, examples can also be edited.

Code Examples

The following markdown will create a page that has the explanation, the example code and a run button that can be used to actually run the code in the browser.


 Click the <button disabled>Run</button> in this example to see it in action.
 ~~~ javascript { runnable: true }
 window.alert("See? It's really simple!");
 ~~~

 ````

You may want some support code to always run:

````markdown

 ~~~ { inject: 'script' }
 function showAlert(text) {
   window.alert(text);
 }
 ~~~



 Click the <button disabled>Run</button> in this example to see it in action.
 ~~~ javascript { runnable: true }
 showAlert("See? It's really simple!"); // uses the function defined above
 ~~~

 ````



Links

[docco]

[docco]:http://github.com/jashkenas/docco