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

@skills17/competitor-readme

v2.1.7

Published

Generate HTML and PDF readmes for competitors out for markdown files.

Downloads

39

Readme

skills17/cypress-helpers

This package provides a framework to write test projects for skills related competitions. It includes:

  • Components to render competitor instructions and ask competitors to sign up
  • Commands
    • start or build the test project with live refresh competitor-readme
    • generate PDF documents of each task module convert-to-pdf
  • ... and more

Table of contents

Installation

Requirements:

  • Node 16 or greater

To install this package, simply run the following command:

npm install @skills17/competitor-readme

Alternatively, you can simply run the following command to serve the readme without installing:

npx @skills17/competitor-readme

It is suggested to add the following npm scripts:

  "scripts": {
    "start": "competitor-readme",
    "build": "competitor-readme --build dist",
    "pdf": "convert-to-pdf --skip-build"
  },

This will provide the following commands:

  • npm start - Start the live-refresh server (useful for writing the readme)
  • npm run build - Creates a production build
  • npm run pdf - Creates a PDF per module

Usage

A championship.yaml file needs to be created that contains some information about the championship. It should be placed in the root folder of your project, next to the package.json file.

See the @skills17/competitor-readme/types TypeScript declarations for a detailed description of all available properties in the championship.yaml file.

CLI

As seen in the installation instructions, the competitor-readme command is available.

Running this command will start a development server with live refresh.

License

MIT