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

endokken

v0.3.0

Published

Generates HTML documentation for your Atom package from AtomDoc comments.

Downloads

14

Vulnerabilities

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

Links

Git

Maintainers

lee-dohmlee-dohm

Keywords

Readme

Endokken Build Status Dependency Status

Generates HTML documentation for your Atom package from AtomDoc comments in your code and your GitHub project's own Markdown files.

Command-Line Interface

You can simply run the endokken command from the root directory of your Atom package and it will generate HTML documentation in the ./docs directory.

$ endokken

Endokken also supports the following command-line options:

  • --extension [EXT] Adds the given extension to all generated documentation files. Defaults to no extension for REST-like purity.
  • --metadata [FILENAME] Dumps the AtomDoc metadata to the file name you provide or api.json if no filename is given.
  • --help Displays command-line help

Acknowledgements

Endokken was originally envisioned as YARD for Atom packages. As such, Endokken owes a lot of its inspiration and ideas to YARD and its author Loren Segal.

Copyright

Copyright © 2014-2015 by Lee Dohm and Lifted Studios. See LICENSE for details.