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

generator-skjol

v3.1.2

Published

Generator allowing you to scaffold documentation for your projects.

Downloads

12

Readme

generator-skjol

npm version CI Coverage Status

Need to document your project with schemas (UML, Graphs, ...), a PDF report or slides? Skjöl is for you! Skjöl allows you to scaffold the needed configuration into your project to be able to generate documentation only based on simple text files.

Skjöl is a group of generators and contains the following:

  • kroki: scaffolds a docker-compose stack that uses kroki to generate diagrams and schemas from text files
  • slides: scaffolds a slide show based on Markdown and ouputs a reveal.js presentation with pandoc
  • report: scaffolds a docker-compose stack that uses pandoc to generate a PDF from a Markdown file

Now you can wonder why this generator is named skjöl. Simply because skjöl means documents in icelandic. That might be disappointing but that's why!

Installation

To install this generators on your system, run npm install --global generator-skjol.

Use the generators

You can then call the generators using Yeoman.

To scaffold slides documentation in a folder named my-slides, run yo skjol:slides my-slides.

To scaffold diagrams documentation in a folder named my-diagrams, run yo skjol:kroki my-diagrams.

To scaffold a report documentation in a folder named my-report, run yo skjol:report my-report.