Middleman-Blog extension
middleman-blog
is an extension for the Middleman static site generator that
adds blog-specific functionality. This includes:
- Handling blog articles
- Helpers for listing articles
- Tagging support
Installation
If you're just getting started, install the middleman
gem and generate a new
project:
gem install middleman
middleman init MY_PROJECT --template=blog
If you already have a Middleman project, add the gem "middleman-blog"
line to your
Gemfile
and then run bundle install
.
Configuration
Within the config.rb of the middleman project, include the line
activate :blog
A more extensive guide can be found in the Middleman blogging guide.
Additionally, up-to-date generated code documentation is available on RubyDoc.
Community
Please also visit the the official Middleman community forum
Bug Reports
Github Issues are used for managing bug reports and feature requests.
If you run into issues or have an idea; please search and then submit the ticket here
The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit Pull Requests containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.
Testing
You can run all the tests by:
- Checkout Repository:
git clone https://github.com/middleman/middleman-blog.git
- Install Bundler:
gem install bundler
- Run
bundle install
inside the project root to install the gem dependencies. - Run test cases:
bundle exec rake test
To run an individual test use:
bundle exec cucumber features/blog_sources.feature
If you have suggestions for testing practices please submit a request.
Creating documentation
bundle exec rake doc
Donate
Click here to lend your support to Middleman
License
Copyright (c) 2010-2017 Thomas Reynolds. MIT Licensed, see LICENSE for details.