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

grunt-init-ghpages

v0.1.1

Published

Quickly build gh-pages documentation from a project README using Grunt.js and Assemble, a Node.js alternative to Jekyll.

Downloads

8

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

doowbdoowbjonschlinkertjonschlinkert

Keywords

alternative to Jekyllassemblebuild gh-pagesgenerate gh-pagesgeneratorgh-pagesgrunt handlebarsgrunt initgrunt plugingruntplugingrunt taskgrunt templatesgruntpluginhandlebarsinitmarkdowngeneratorsite generatoryeoman generatoryeomanyo

Readme

grunt-init-ghpages

Quickly build gh-pages documentation from a project README using Grunt.js and Assemble, a Node.js alternative to Jekyll.

Getting started

Installation

If you haven't already done so, install Grunt and grunt-init:

npm i -g grunt-cli grunt-init

Once grunt-init is installed, place this template in your ~/.grunt-init/ directory. It's recommended that you use git clone to install this template into that directory as follows:

git clone https://github.com/assemble/grunt-init-ghpages.git ~/.grunt-init/ghpages

(Windows users, see the documentation for the correct destination directory path)

To force grunt-init to use custom default values, move the defaults.json file to your ~/.grunt-init/ directory, and customize the values in that file.

Note: you can make the template available as any name you choose by simply changing the name of the folder that the template is installed into. So instead of ~/.grunt-init/ghpages, you may change the name to ~/.grunt-init/foo so that the template can be used with the following command: grunt-init foo.

Usage

Now that grunt init is intalled. At the command-line, cd into an empty directory and run grunt-init assemble and follow the prompts. You might want to test that it works before you begin customizing the project:

  • Next, run npm install to install the project's dependencies.
  • Then, run grunt to build the project and test that it works.

Note that this template will generate files in the current directory, so be sure to change to a new directory first.

What this project contains

In the the test directory you will find the following files:

  • example.hbs: this is an example template, which contains code for both an example helper and a starting point for your new custom helper.
  • example.json: this is the data file used by the helper
  • helper-example.js: umm...

Related info

Author

Jon Schlinkert

Copyright and license

Copyright 2013 Jon Schlinkert

MIT License