Markwiki

Markwiki is a Ruby gem designed to ease the development and maintenance of locally designed static sites using Markdown. Too often, at least for me, static site generators aren't intuitive to use, aren't focused for simple static sites (not blogs), or most often don't support GitHub flavoured Markdown (GFM).

Markwiki follows the philosophy that you should have to do as little configuration as possible, with the ability to customize as much as possible. A Markwiki site begins as a skeleton directory structure as a YAML or JSON file, known as a configuration. These configurations are designed to be as intuitive as possible.

Installation

NOTE: Markwiki is still is pre-alpha. Don't have high expectations, or really any expectations at all.

Add this line to your application's Gemfile:

gem 'markwiki'

And then execute:

$ bundle

Or install it yourself as:

$ gem install markwiki

Usage

# SIMPLE USAGE
Usage: markwiki [options]
    -i <NAME>, --init <NAME>         Create a new Markwiki site
    -v, --version                    Show the Markwiki version number
    -h, --help                       Display this help menu

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mahimahi42/markwiki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

mahimahi42 / markwiki