https://github.com/middleman/middleman-blog
Blog Engine Extension for Middleman
https://github.com/middleman/middleman-blog
blog blog-engine middleman middleman-blog middleman-extension ruby static-site-generator
Last synced: about 1 month ago
JSON representation
Blog Engine Extension for Middleman
- Host: GitHub
- URL: https://github.com/middleman/middleman-blog
- Owner: middleman
- License: mit
- Created: 2011-08-20T00:45:44.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T15:24:25.000Z (2 months ago)
- Last Synced: 2025-04-14T13:07:24.256Z (2 months ago)
- Topics: blog, blog-engine, middleman, middleman-blog, middleman-extension, ruby, static-site-generator
- Language: Gherkin
- Homepage: https://middlemanapp.com
- Size: 782 KB
- Stars: 324
- Watchers: 17
- Forks: 181
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Middleman-Blog extension
[][gem]
[](https://github.com/middleman/middleman-blog/actions/workflows/ci.yml)
`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
- Calendar pages
## Installation
If you're just getting started, install the `middleman` gem and generate a new
project:
```bash
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
```ruby
activate :blog
```
A more extensive guide can be found in the [Middleman blogging guide](http://middlemanapp.com/basics/blogging/).
Additionally, up-to-date generated code documentation is available on [RubyDoc].
## Community
Please also visit the the official [Middleman community forum](http://forum.middlemanapp.com)
## 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](https://github.com/middleman/middleman-blog/issues)
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](https://help.github.com/articles/using-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:
1. Checkout Repository: `git clone https://github.com/middleman/middleman-blog.git`
2. Install Bundler: `gem install bundler`
3. Run `bundle install` inside the project root to install the gem dependencies.
4. Run test cases: `bundle exec rake test`
To run an individual test use:
```bash
bundle exec cucumber features/blog_sources.feature
```
## Creating documentation
```bash
bundle exec rake doc
```
## Donate
[Click here to lend your support to Middleman](https://github.com/sponsors/tdreyno)
## License
Copyright (c) 2010-2017 Thomas Reynolds. MIT Licensed, see [LICENSE] for details.
[middleman]: http://middlemanapp.com
[gem]: https://rubygems.org/gems/middleman-blog
[rubydoc]: http://rubydoc.info/github/middleman/middleman-blog/master
[LICENSE]: https://github.com/middleman/middleman-blog/blob/master/LICENSE.md