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

redok

v0.2.0

Published

Readme and documentation generator

Downloads

21

Vulnerabilities

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

Links

Git

Maintainers

adamrenklintadamrenklint

Keywords

Readme

redok

Readme and documentation generator

Join the chat at https://gitter.im/adamrenklint/redok npm version npm monthly downloads GitHub stars GitHub forks npm dependencies

redok is a tool for generating README and repo documentation using Handlebars and Markdown, and aims to speed up the most common tasks.

Installation

$ npm install -g redok

Usage

Generate output files for all templates in the folder .docs. For example, .docs/README.md would become your project's main readme file.

$ redok

Options

It is possible to pass options to the command line tool.

Load templates and partials from .alternate/

$ redok --dir .alternate

Watch and regenerate on change

$ redok --watch

Partials

If your readme is growing, it's smart to split the template up into smaller chunks. All .hbs files in .docs/partials are available as Handlebars partials:

{{>foo}}

Badges

redok comes with a few built-in partials for generating badges.

|Description|Code|Example| |---|---|---| |Gitter chat|{{>badges/gitter}};|Join the chat at https://gitter.im/adamrenklint/redok| |npm version|{{>badges/npm-version}}|npm version | |npm downloads|{{>badges/npm-downloads}}|npm monthly downloads| |npm dependencies|{{>badges/npm-dependencies}}|npm dependencies| |npm devDependencies|{{>badges/npm-devDependencies}}|David devDependencies| |Github stars|{{>badges/github-stars}}|GitHub stars| |Github forks|{{>badges/github-forks}}|GitHub forks| |Travis CI status|{{>badges/travis}}|Travis CI status| |CodeClimate score|{{>badges/codeclimate-score}}|Code Climate score| |CodeClimate coverage|{{>badges/codeclimate-coverage}}|Code Climate coverage|

License

MIT © 2015 Adam Renklint

Generated with redok @ Friday June 12th, 2015 - 11:04:19 AM