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

lhs-grunt-styledown

v1.0.0

Published

Grunt plugin to generate style guides via styledown

Downloads

2

Readme

lhs-grunt-styledown

Grunt plugin to generate style guides via Styledown

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install lhs-grunt-styledown --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-styledown');

The "styledown" task

Overview

In your project's Gruntfile, add a section named styledown to the data object passed into grunt.initConfig().

grunt.initConfig({
  styledown: {
    build: {
      files: {
        'dist/styleguide/index.html': ['src/styleguide/*.md']
      },
      options: {
        css: 'dist/css/my-styles.css',
        js: 'dist/js/my-scripts.js',
        title: 'My Style Guide'
      }
    },
  },
})

Options

css

Type: String or Array
Default: none

One or multiple CSS file paths to reference from the styleguide. <link> tags will be included in the style guide <head> for each path.

js

Type: String or Array
Default: none

One or multiple JavaScript file paths to reference from the styleguide. <script> tags will be included at the bottom of the style guide <body> for each path.

title

Type: String
Default: Styledown

A title to use in the style guide's <title> tag.

sg_css

Type: String or Array
Default: https://cdn.rawgit.com/styledown/styledown/v1.0.1/data/styledown.css

One or multiple supporting CSS file paths to reference from the styleguide. By default, this will be the supporting CSS file packaged with the latest version of Styledown. Set to null to remove.

sg_js

Type: String or Array
Default: https://cdn.rawgit.com/styledown/styledown/v1.0.1/data/styledown.js

One or multiple supporting JavaScript file paths to reference from the styleguide. By default, this will be the supporting JavaScript file packaged with the latest version of Styledown. Set to null to remove.

config

Type: String
Default : none

A Styledown Markdown configuration file.

Warning: Setting the styleguide's <head> content via this file will overwrite the css, sg_css, and title options described above. Similarly, any <body> content set via this file will overwrite the js and sg_js options.

Usage Examples

Coming soon.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

License

Copyright (c) 2015 Drake Hampton. Licensed under the MIT license.