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

roots-collections

v0.3.3

Published

Content collections in markdown with frontmatter for Roots

Downloads

8

Readme

Roots Collections

Content Collections based on Markdown with Frontmatter for the Roots static site generator.

Installation

  • make sure you're in your roots project directory

  • npm install roots-collections --save

  • modify your app.coffee file to include the extension

    collections = require 'roots-collections'
    
    module.exports =
      extensions: [collections(folder: 'posts', layout: 'post')]

Usage

Once you've installed the extension, Roots will search the specified folder for collections and make them available in your templates.

Files in the folder should end with the extension .md and be written as markdown with YAML frontmatter:

---
title: This is the title
desc: A description
---

# I am markdown

Hello

If the file names follow the following patter:

/posts/2015-05-04-this-is-a-blog-post.md

The extension will automatically add a date to the entries based on the date in the filename.

If a layout is specified, each entry will be rendered with the specified layout. The layout template can access an entry variable with the title, date, slug, body, and other metadata from the entry.

extends layout

block content  
  h3.post-title= entry.title
  .post-body!= entry.body

Entry Listings

The name of the collection is based on the folder, unless you explicitly set a name when configuring the extension.

So if you configure the extension with posts(folder: 'posts') you will be able to use posts.orderBy('date','desc') in templates. If you configure the extension with posts(folder: 'docs'), you'll be able to use docs.orderBy('title') in templates.

Example:

.recent-posts-listing
  each post in posts.orderBy('date', 'desc').slice(0, 10)
    h3.title
      a.post-title(href=post.permalink)= post.title
    .body!= post.body

Computed Entry Properties

By default the collections extension will compute the slug, permalink,date and body properties based on the filename of each entry, but you can also hook into the compilation phase to add your own computed properties or modify any of the default properties, by passing a prepare function to the extension:

Here's a simple example of adding an upcased_title property to each entry.

module.exports =
  extensions: [collections(
    folder: 'posts',
    layout: 'post',
    prepare: (post) ->
      post.upcased_title = post.title && post.title.toUpperCase()
  )]

License

This extension is published under the MIT License