Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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: 4 days 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 (over 13 years ago)
Default Branch: master
Last Pushed: 2024-05-10T04:16:46.000Z (8 months ago)
Last Synced: 2024-09-19T05:41:25.613Z (3 months ago)
Topics: blog, blog-engine, middleman, middleman-blog, middleman-extension, ruby, static-site-generator
Language: Gherkin
Homepage: https://middlemanapp.com
Size: 765 KB
Stars: 325
Watchers: 19
Forks: 179
Open Issues: 15
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 Version](https://badge.fury.io/rb/middleman-blog.svg)][gem]
[![CI](https://github.com/middleman/middleman-blog/actions/workflows/ci.yml/badge.svg)](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

## 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](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:

1. `bundle exec cucumber features/blog_sources.feature`

If you have suggestions for testing practices please submit a request.

## Creating documentation

1. `bundle exec rake doc`

## Donate

[Click here to lend your support to Middleman](https://github.com/sponsors/tdreyno)

## License

[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