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

html-inject-github-corner

v2.1.4

Published

Add a github corner to a stream of html

Downloads

11

Readme

html-inject-github-corner

Add a Github corner to a stream of html

Build Status npm version Dependency Status Standard Style unstable

Introduction

Tim Holman's Github Corners are great! This is a quick way to avoid having to copy/paste them by hand. 😀

Installation

$ npm install html-inject-github-corner

Example

This tool works great with indexhtmlify and html-inject-meta. For example:

$ browserify index.js | indexhtmlify | html-inject-meta | html-inject-github-corner > index.html

Usage

This tools takes a stream of html and transforms it to include a github corner. It looks first to direct options, then to the repository field of the nearest package.json, and finally will accept any of these options from a github-corner field in package.json.

Options:
     --help  Display this message and exit
       --bg  Background color
       --fg  Foreground color
  --z-index  CSS z-index of corner (default: 10000)
 --position  CSS position of corner (default: 'absolute')
    --class  CSS class for element (default: 'github-corner')
      --url  Repository url (by default, looks at repository url of nearest package.json
     --side  Either "left" or "right"

  $ browserify index.js | indexhtmlify | html-inject-meta | html-inject-github-corner > index.html

API

This can also be used as a through stream:

require('html-inject-github-corner')([opts])

This creates a through stream that transforms html to include a github corner. The options are exactly the same as for the command line version:

  • bg: A valid CSS color for the triangular background
  • fg: A valid CSS color for the octocat foreground
  • zIndex: The z-index of the corner. Default is 10000.
  • position: The CSS position of the corner. Default is 'absolute'.
  • repository: A url to use in the link. Follows the format of the package.json repository field. If not provided, the nearest package.json will be located and analyzed. Within reason, will transformed to a web url.
  • side: 'left' | 'right'. Default side for the link is the right side.
  • class: An optional CSS class for the element. Default is .github-corner.

Returns: A through stream that appends CSS into the head tag and prepends the github corner to the HTML.

See Also

License

© 2016 Ricky Reusser. MIT License. Original assets are adapted from tholman/github-corners. See LICENSE for more details.