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

gist-author

v0.0.2

Published

Gist Author provides user experiences over Gist-backed content. This system is aimed at the strange subset up authors who want to publish content (sometimes on an ad-hoc bases) AND who are already invested in Gist-based [tools](https://github.com/defunkt/

Downloads

4

Readme

Gist Author

Gist Author provides user experiences over Gist-backed content. This system is aimed at the strange subset up authors who want to publish content (sometimes on an ad-hoc bases) AND who are already invested in Gist-based tools and integrations.

Authors can create content in any markdown-friendly editor by posting a gist of markdown. The content is then published via a CLI tool that can output a static app for viewing the content. Larger contexts can be created around collections of Gists by publishing additional "metadata Gists" that declare which "content Gists" should be included in the contexts' "collection". For example a group of Gists could be organized into a blog, CMS, book, course, or other format by publishing a YAML document as a Gist.

Install

yarn global add gist-author

Usage

Sign in

The first time you use Gist Author you must sign in. The CLI doesn't yet provide a way to sign in. In the meantime visit your Github settings to generate an personal access token. The only scope it requires is gist.

Create a token in your Github Developer account settings.

Then copy and paste your token to your Gist Author config file

mkdir ~/.config
chmod 700 ~/.config
echo GITHUB_ACCESS_TOKEN > ~/.config/gist-author

Publishing a single post

Publishing a single post is as simple as having a compatible markdown Gist and then invoking the CLI's publish command with the Gist ID.

  1. Create a markdown Gist. To be compatible the Gist must be in markdown format, starts with a top-level (H1) header, and must not be a multi-file Gist.

  2. Publish the Gist as a post by ID

    gist-author publish <gist-id>

Publishing a blog

Publishing a blog is accomplished by publishing compatible markdown Gists, publishing a manifest Gist in YAML format, and then invoking the CLI's publish command with the Gist ID.

  1. Create Gists for each post similarly to the instructions for publishing a single post.

  2. Publish a YAML gist that includes a role and list of Gist post ids

    role: blog
    title: Mikes blog!
    subtitle: Full of great content!
    ids:
    - "05c66b94af10c7d63b912e21bad3195c"
    - "7ae04c3572b338d0ac6227e9dab84837"
  3. Publish the YAML Gist as a blog by ID

    gist-author publish <gist-id>

Setting a theme

A theme can be set when exporting site, e.g.

See styled-jsx-themes for a full list of themes.

gist-author publish <gist-id> --theme earthly

Or a theme can be set when configuring context, e.g.

role: blog
title: Mikes blog!
theme: earthly
subtitle: Full of great content!
ids:
- "05c66b94af10c7d63b912e21bad3195c"
- "7ae04c3572b338d0ac6227e9dab84837"