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

embed-examples

v1.0.0

Published

Embed examples into README.md

Downloads

3

Readme

embed-examples

npm version Build Status

Embed examples into README.md

:rocket: Installation

npm install -g embed-examples

:eyes: Overview

Thie module embeds examples into README.md.

For example, put the following file ...

my-lib/README.md)

# my-lib
<!-- embed-examples: examples/foo.js -->

my-lib/examples/foo.js)

const myLib = require('my-lib');
myLib.doSomething();

Executing the following command ...

embed-examples -o ./README.md

README.md is updated as follows!

my-lib/README.md)

# my-lib
<!-- embed-examples: examples/foo.js -->
<!-- embed-example -->
```
const myLib = require('my-lib');
myLib.doSomething();
```
<!-- /embed-example -->

:scroll: Usage

embed-examples [OPTIONS] README_PATH
  • README_PATH
    • Relative path to the README.md
  • OPTIONS
    • --examples-dir $VALUE, -e
      • Base path for finding examples
      • Default: A directory path where README.md is located
    • --newline-character $VALUE, -n
      • Newline character used in markdown. However, do not change the sources of examples.
      • The value is "LF", "CR" or "CRLF"
      • Default: "LF"
    • --overwrite, -o
      • Directly rewrite README.md with path specified
      • Default: Disabled
    • --replacement $VALUE, -r
      • Keywords to replace. Represent value in the form of from,to.
      • Can specify more than one like -r keyword1,replacement1 -r keyword2,replacement2
      • Default: None