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-assemble-anchors

v0.1.0

Published

Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js.

Downloads

19

Readme

grunt-assemble-anchors NPM version

Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js.

Example

Before

<h1 id="glyphicons">Glyphicons</h1>

After

<h1 class="docs-heading">
  <a href="#heading-id-name" name="heading-id-name" class="anchor">
    <span class="anchor-target" id="heading-id-name"></span>
    <span class="glyphicon glyphicon-link"></span>
  </a>
  Glyphicons
</h1>

Currently the plugin adds Bootstrap glyphicon classes. If you want to use different classes, find a bug, or have a feature request, please create an issue

image

Visit the anchors example repo.

Quickstart

In the command line, run:

npm install grunt-assemble-anchors --save

Next, register the plugin with Assemble:

assemble: {
  options = {
    plugins: ['grunt-assemble-anchors', 'other/plugins/*']
  }
};

Options

template

Specify a custom template (Underscore/Lo-Dash) to use for anchor markup. This is the default template:

module.exports = [
  '<a href="#<%= id %>" name="<%= id %>" class="anchor">',
  '  <span class="anchor-target" id="<%= id %>"></span>',
  '  <span class="glyphicon glyphicon-link"></span>',
  '</a>'
].join('\n');

To use a custom template just specify it in the options as follows:

options: {
  plugins: ['grunt-assemble-anchors'],
  anchors: {
    template: './path/to/custom/template.js'
  }
}

Visit the plugins docs for more info or for help getting started.

Other grunt-assemble plugins

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Brian Woodward

License

Copyright © 2015 Brian Woodward Released under the MIT license.


This file was generated by verb-cli on September 24, 2015.