Skip to content

IotaSpencer/mkmatter

Repository files navigation

mkmatter

Travis branch Travis branch

Gem GitHub tag

Gem Gem License: MIT

forthebadge forthebadge forthebadge

Contact

E-mail Twitter Follow

Website

E-mail

About mkmatter

'mkmatter' is a gem designed to make it easy to generate front matter for files and also subsequently edit them.

Note: Just like Jekyll there are minimal constraints on what is needed to build, but for mkmatter all I ask is that there is a _config.yml in your site source root, so the executable knows where it is in the filesystem.

This is needed for any part that reads from/writes to the filesystem.

Installation

Note: Thanks to @zyedidia, His project micro has been bundled alongside mkmatter. Just by using one command you can install it for your own use.

However, to use micro the way its installed using the gem, you need to have the directory in your $PATH.

Micro Installation

Add

PATH="$HOME/bin:$HOME/.local/bin:$PATH"

If you do install micro, it will use micro by default unless you override it with --editor=EDITOR

Mkmatter Installation

Bundler

Add this line to your application's Gemfile:

gem 'mkmatter'

And then execute:

$ bundle install

Standalone

To install to the system/user instead of a project, use the following

System-wide

As root or by using sudo, run:

$ gem install mkmatter

or

$ sudo gem install mkmatter
User
$ gem install --user-install mkmatter

Usage

See Wiki

Contributing

  • I am open to the idea of adding more questions/modules if there are plugins that require more configuration in the front matter. Just let me know!

  • Bug Reports

  • Pull Requests

License

The gem is available as open source under the terms of the MIT License.