Rpx

Zero-configuration static-site generator for blogs

Features

• Minimal, Spartan look
• No theming or setup required
• Fast page loads with static pages
• Client-side routing for fast navigation transitions
• Parses markdown to create Open Graph meta tags
• Adds Tweet buttons to posts
• Automatic pagination
• Works with many of the same front matter variables as Jekyll

Getting Started

npm i -g rpx

Alternatively, Rpx can be installed as a devDependency with the -D flag.

Run the command pointing to a folder containing markdown files.

rpx posts

By default this creates a folder named build and saves the static site here.

This command will filter for markdown files to use as posts. The filename will be used as the URL path, and each markdown file should contain a minumum of the following front matter:

---
title: Hello World
date: 2016-10-11
---

Rpx will also check for the existance of a .png or .jpg image in the source folder for use as a Twitter/OG image. If favicon.ico, favicon.png, or apple-touch-icon.png files are found, they will also be copied to the build folder.

CLI Options

-h, --help      Shows help text
-o, --out-dir   Output directory

Configuration

Add an rpx object to your package.json.

"rpx": {
  "title": "My blog"
}

The following configuration options are available:

• title: title of the site
• description: description of the site
• image: Image used for Twitter and OG metatags and apple-touch-icon
• author: author of the site
• css: Source for csutom CSS file
• styles: Custom CSS string to inline in the head
• googleAnalytics: ID for Google Analytics account
• pageSize: Number of posts to show per page
• twitter: Object for Twitter metatags
  • twitter.site: Twitter username for the site

MIT License