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

apostrophe-blog

v2.2.2

Published

Blogging for the Apostrophe content management system

Downloads

332

Readme

apostrophe-blog

This bundle provides a complete foundation for blogging with the Apostrophe CMS.

The bundle consists of three Apostrophe modules (in a single npm module):

  • apostrophe-blog
  • apostrophe-blog-pages
  • apostrophe-blog-widgets

The apostrophe-blog module provides the ability to create and edit blog posts and manage their publication dates.

The apostrophe-blog-pages module displays blog posts on a page. It extends the apostrophe-pieces-pages module. A blog page displays only blog posts whose publication date has arrived.

The apostrophe-blog-widgets module provides an apostrophe-blog widget, which you can use to select blog posts to appear anywhere on your site. Posts do not appear until their publication date.

These three modules extend apostrophe-pieces, apostrophe-pieces-pages and apostrophe-pieces-widgets, and you can extend them further as well.

Example configuration

For a single blog:

// in app.js
// We must declare the bundle!
bundles: [ 'apostrophe-blog' ],
modules: {
  'apostrophe-blog': {},
  'apostrophe-blog-pages': {},
  'apostrophe-blog-widgets': {},
  'apostrophe-pages': {
    // We must list `apostrophe-blog-page` as one of the available page types
    types: [
      {
        name: 'apostrophe-blog-page',
        label: 'Blog'
      },
      {
        name: 'default',
        label: 'Default'
      },
      {
        name: 'home',
        label: 'Home'
      }
    ]
  }
}

Contextual editing

You can set the contextual: true option for the apostrophe-blog module if you prefer to allow the end user to edit the content of the article "in context" on the show.html page. This is generally the preferred way to go.

You can also set contextual: true for individual schema fields like body so that they don't appear in the modal at all.

When contextual: true is set for the module, the user is redirected to the "show page" for that blog post as soon as they click "save" so that they can edit further.

In addition, the "context menu" (the "Page menu") is enhanced with blogging-related choices when on a blog index page or show page.

Multiple blogs

One way to create two or more blogs is to create separate blog pages on the site, and use the "with these tags" feature to display only posts with certain tags.

Another approach is to extend the modules, creating new modules and a completely separate admin bar item for managing the content. If you take this approach, you must set a distinct name property when configuring your subclass of apostrophe-blog, such as article. This will be value of type in the database for each blog post of this subclass.

The latter approach is often best as it requires less user training to avoid confusion. The former approach has its own advantages, notably that it is easier to aggregate content and have it appear in multiple places intentionally.

Filtering blog posts

The index page includes filters for day, month, and year, meaning that parameters in query strings like &year=2016 will automatically be passed to the mongo query that loads the pieces for your index page. You can refer to these filters in your template by using data.piecesFilters.year, etc.

Check out this tutorial to learn more.