Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iotaspencer/mkmatter

Ruby gem for generating Jekyll posts and pages
https://github.com/iotaspencer/mkmatter

badges executable gem jekyll ruby rubygems script

Last synced: 3 months ago
JSON representation

Ruby gem for generating Jekyll posts and pages

Host: GitHub
URL: https://github.com/iotaspencer/mkmatter
Owner: IotaSpencer
License: mit
Created: 2018-01-17T11:36:12.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2024-03-25T05:42:47.000Z (10 months ago)
Last Synced: 2024-04-25T14:41:55.842Z (9 months ago)
Topics: badges, executable, gem, jekyll, ruby, rubygems, script
Language: Ruby
Homepage: https://iotaspencer.me/projects/mkmatter
Size: 182 KB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # mkmatter

[![Travis branch](https://img.shields.io/travis/IotaSpencer/mkmatter/dev.svg?style=for-the-badge)](https://travis-ci.org/IotaSpencer/mkmatter)

[![Travis branch](https://img.shields.io/travis/IotaSpencer/mkmatter/master.svg?style=for-the-badge)](https://travis-ci.org/IotaSpencer/mkmatter)

[![Gem](https://img.shields.io/gem/v/mkmatter.svg?style=for-the-badge)](https://rubygems.org/gems/mkmatter)

[![GitHub tag](https://img.shields.io/github/tag/IotaSpencer/mkmatter.svg?style=for-the-badge)](https://github.com/IotaSpencer/mkmatter/tree/v3.0.27)

[![Gem](https://img.shields.io/gem/dt/mkmatter.svg?style=for-the-badge)](https://rubygems.org/gems/mkmatter)

[![Gem](https://img.shields.io/gem/dtv/mkmatter.svg?style=for-the-badge)](https://rubygems.org/gems/mkmatter)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)

[![forthebadge](https://forthebadge.com/images/badges/uses-badges.svg)](https://forthebadge.com)

[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)

[![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com)

## Contact

[![E-mail](https://img.shields.io/badge/Email-Me-green.svg?style=for-the-badge)](mailto:[email protected])

[![Twitter Follow](https://img.shields.io/twitter/follow/IotaEcode.svg?label=Follow%20Me%20on%20Twitter&style=for-the-badge)](https://twitter.com/iotaspencer)

[![Website](https://img.shields.io/website-up-down-green-red/https/iotaspencer.me.svg?label=My%20Site%20-%20IotaSpencer%2Eme&style=for-the-badge)](https://iotaspencer.me)

[![E-mail](https://img.shields.io/badge/mkmatter%20on%20IotaSpencer%2eme-Project-green.svg?style=for-the-badge)](https://iotaspencer.me/projects/mkmatter)

## 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](https://github.com/zyedidia), His project [micro](https://github.com/zyedidia/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 

```shell

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:

```ruby

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](https://github.com/IotaSpencer/mkmatter/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](https://github.com/IotaSpencer/mkmatter/issues)

* [Pull Requests](https://github.com/IotaSpencer/mkmatter/pulls)

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).