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

statical-ghost

v1.0.4

Published

another static blog generator using ghost themes

Downloads

4

Readme

statical-ghost

another static blog generator using ghost theme

INSTALL

npm i -g statical-ghost

FEATURES

USAGE

init blog folders

first, you need initialize folders in current directory.

sg init # or sg i

then, you got a structure like this:

<current directory>
  |-posts   # for your markdown posts, supports sub directory
  |-files   # files below this directory will be copied to /public
  |-public  # this directory include the generated blog site
  |-tmp     # temp directory, speed up generating
  |-themes  # ghost themes

this command not only create directories, but also generate demo post, config.yaml and even downloading a default ghost theme Casper. You can right your posts in /posts.

after this command, actually you have already got everything ready, just enter next step.

generate

now you can generate your blog, it's very fast because of using multi-process

sg generate # or sg g

server

you can see your /public directory added many files, then run

sg server # or sg s

to start a local static server, it also auto generate your posts if posts or theme are changed. now click http://127.0.0.1:8080 to enjoy your blog !!!

see help

sg -h

then you can get messages below:

Usage: sg sg [command] [options]


  Commands:

    generate|g             generate blog
    init|i                 initialize blog structure in current directory
    clean|c                clean temp dir
    deploy|d               deploy to server, use config.deploy in config.yaml as command
    generateAndDeploy|gd   generate and deploy
    server|s               start a static server, which would auto generate when posts changed

  another static glog generator by ghost theme

  Options:

    -h, --help           output usage information
    -V, --version        output the version number
    -c, --config <path>  set config path. defaults to ./config.yaml
    -p, --port           the port of local server

config file

config.yaml

blog:
  url: 'http://localhost:8080'
  title: My Blog
  description: Keep It Simple and Stupid.
  logo: ''
  cover: ''
  navigation:
    - label: Index
      url: /
theme: Casper
deploy: git add -A;git commit -m 'new post';git push origin master;
# routeKeywords: # link 'author' in http://localhost:8080/author/me
#   tag: tag
#   author: author
#   page: page
paths:
  # subdir: 'blog'    #subdir for all urls, like "http://localhost:8080/blog/author/me"
  # imagesRelPath: '' not use yet
  posts: /posts # directory for your posts
  public: /public # directory for generated site
  tmp: /tmp # temp directory for speed up
  themes: /themes # directory for themes
posts:
  limit: 5   # the number of posts in each page
  permalinks: '/:year/:month/:day/:slug/' # link of post
author: me # default author
authors: #other authors
  me:
    name: me
    slug: me
    bio: Think
    # image: ''
    # cover: ''
    # website: ''
    # location: Beijing
    # meta_title: ''
    # meta_description: ''
tags: # all tags, it would be auto appended after appear in posts
  # hello:
  #   name: hello
  #   slug: hello
  #   description: ''
  #   image: ''
  #   hidden: ''
  #   meta_title: test
  #   meta_description: test
  #   parent: ''
  world:
    name: world
    slug: world

TODO

use graceful-fs