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

gatsby-source-gh

v0.1.0

Published

Gatsby source plugin for GitHub repositories

Downloads

1

Readme

gatsby-source-gh

Gatsby source plugin for files in a GitHub repository

Installation

1. Add this package as a dependency

yarn add gatsby-source-gh

npm install --save gatsby-source-gh

2. Configure the plugin in gatsby-config.js

module.exports = {
  plugins: [
    {
      resolve: `gatsby-source-gh`,
      options: {
        repo: `<GITHUB_REPOSITORY>`,
        user: `<GITHUB_USERNAME>`,
      },
    },
  ],
}

3. Querying

All queried files will return a node with content containing the raw text of the file and all of the data returned when querying for a file on GitHub's API.

Example query

query GitHubQuery {
  allGitHubFile {
    edges {
      node {
        name
        path
        content
      }
    }
  }
}

Example response

{
  "name": "hello.md",
  "path": "content/hello.md",
  "content": "Hello world",
  "sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
  "type": "file",
  "size": 5362,
  "url": "https://api.github.com/repos/shwilliam/shwilliam/contents/hello.md",
  "git_url": "https://api.github.com/repos/shwilliam/shwilliam/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
  "html_url": "https://github.com/shwilliam/shwilliam/blob/master/hello.md",
  "download_url": "https://raw.githubusercontent.com/shwilliam/shwilliam/master/hello.md",
  "_links": {
    "git": "https://api.github.com/repos/shwilliam/shwilliam/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
    "self": "https://api.github.com/repos/shwilliam/shwilliam/contents/hello.md",
    "html": "https://github.com/shwilliam/shwilliam/blob/master/hello.md"
  }
}

Contributing

This project is open to and encourages contributions! Feel free to discuss any bug fixes/features in the issues. If you wish to work on this project:

  1. Fork this project
  2. Create a branch (git checkout -b new-branch)
  3. Commit your changes (git commit -am 'add new feature')
  4. Push to the branch (git push origin new-branch)
  5. Submit a pull request!