README.textile

October 18, 2017 ยท View on GitHub

Note this project is now unsupported, and I've given the 'pop' npm name to someone else to use for a more active project.

h3. Features

Pop is a static site builder for Node, optimised for blogs; based on "Jekyll":https://github.com/mojombo/jekyll.

  • Designed to be a workhorse for large production blogs
  • Useful built-in helpers: hNews post generation, pagination, tags
  • Extend using your own helpers and pre-filters
  • Plugins

h3. Documentation

h3. Configuration File Options

Must be valid JSON.

{  "url": "http://popjs.com/"                   // Your site's URL
 , "title": "Pop Blog"                          // The title of your site
 , "permalink": "/:year/:month/:day/:title"     // Post link format
 , "paginate": 10                               // Number of posts to include on a page
 , "exclude": ["\\.swp"]                        // Files to exclude
 , "require": ["pop-disqus"]                    // Plugins
 , "output": "_site/"                           // The place to put the generated HTML
 , "autoGenerate": [{"feed": "feed.xml"}]       // Files to autogenerate using Pop's built-in pages
}

h3. Contributions

  • George Ornbo
  • Windows support by Brian Carlson (brianc)

h3. Plugins