GitXplorerGitXplorer
e

jekyll2harp

public
10 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
0fc3660a49d3d21e77c9a19855a2cbeb7782bdaf

Update README.md

eedrex committed 11 years ago
Unverified
62340a57650916724781dd69b034b035c8104140

bump version

eedrex committed 11 years ago
Unverified
e2291d3c3a9eff690b6bff98e5f7c5d96218ee94

Add a couple of Mocha tests

eedrex committed 11 years ago
Unverified
47cb26a0ae7dc8b25659ba6ec015676cdbbe5254

Don't reverse order, for now

eedrex committed 11 years ago
Unverified
5a5b6af1f24636480f1514ff24d978c1bb8b3611

update README

eedrex committed 11 years ago
Unverified
1bd1774d5b0c7b43c230ce681f047892cc6114a4

modularize

eedrex committed 11 years ago

README

The README file for this repository.

jekyll2harp

A script to convert posts from Jekyll to Harp

Example:

cd mysite/_posts
jekyll2harp -d ./out mysite/_posts/*.md

Features

  • Parses YAML metadata
  • Parses leading dates in file names
  • Outputs files with metadata stripped
  • Saves metadata to _data.json
  • Outputs to a fresh directory, never modifies existing files or folders
  • Strips out metadata keys specified with -s

Things to know

  • The order of documents in _data.json is the order that you specify files in. You may have to reorder after converting.
  • Think carefully about which metadata fields you want to strip out. The defaults are layout and published.
  • This script doesn't try to preserve old URLs. This sort of thing is possible, but depends on how you plan to deploy (nginx, apache, s3, etc)

Install

npm install -g jekyll2harp

Or if you want to hack on it (pull requests welcome) run it from source like so:

git clone git@github.com:edrex/jekyll2harp.git
cd jekyll2harp
npm install
npm link

Usage

% jekyll2harp -h                                                                                                                                                                  ✭

  Usage: jekyll2harp [options] <file ...>

  Options:

    -h, --help                  output usage information
    -V, --version               output the version number
    -s --skip_keys <skip_keys>  Skip keys
    -d --dest <dest>            Destination directory

TODO

  • Add sorting (+/-fieldname)