middleman-blog 4.0.1 → 4.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.editorconfig +16 -0
- data/.gitignore +5 -1
- data/.travis.yml +33 -19
- data/.yardopts +2 -2
- data/CHANGELOG.md +51 -24
- data/CONTRIBUTING.md +5 -2
- data/Gemfile +23 -16
- data/ISSUE_TEMPLATE.md +14 -0
- data/LICENSE.md +15 -17
- data/README.md +52 -14
- data/Rakefile +10 -7
- data/features/article_dirs.feature +34 -0
- data/features/blog_sources.feature +35 -6
- data/features/filename_date.feature +4 -2
- data/features/language.feature +108 -77
- data/features/layouts.feature +3 -0
- data/features/multiblog.feature +1 -1
- data/features/next_previous.feature +10 -7
- data/features/permalink.feature +17 -0
- data/features/summary.feature +26 -2
- data/features/support/env.rb +7 -4
- data/features/support/time_steps.rb +7 -3
- data/features/tags.feature +68 -34
- data/fixtures/article-dirs-app/config-directory-indexes.rb +6 -0
- data/fixtures/article-dirs-app/config-permalink-with-dot.rb +6 -0
- data/fixtures/blog-sources-app/config.rb +6 -3
- data/fixtures/blog-sources-app/source/blog/2011-01-01-new-article.html.markdown +5 -3
- data/fixtures/blog-sources-app/source/blog/2013-08-08-slug-from-filename.html.markdown +5 -3
- data/fixtures/blog-sources-app/source/index.html.erb +12 -8
- data/fixtures/blog-sources-app/source/layout.erb +21 -10
- data/fixtures/blog-sources-no-date-app/config.rb +6 -0
- data/fixtures/blog-sources-no-date-app/source/blog/new-article.html.markdown +8 -0
- data/fixtures/blog-sources-no-date-app/source/index.html.erb +13 -0
- data/fixtures/blog-sources-no-date-app/source/layout.erb +24 -0
- data/fixtures/blog-sources-no-day-app/config.rb +6 -0
- data/fixtures/blog-sources-no-day-app/source/2012-08-testing.html.markdown +8 -0
- data/fixtures/blog-sources-no-day-app/source/layout.erb +24 -0
- data/fixtures/{no-title-app → blog-sources-no-title-app}/config.rb +3 -0
- data/fixtures/blog-sources-no-title-app/source/2013-08-07.html.markdown +8 -0
- data/fixtures/blog-sources-no-title-app/source/2013-08-08.html.markdown +9 -0
- data/fixtures/{no-date-app → blog-sources-no-title-app}/source/layout.erb +11 -0
- data/fixtures/blog-sources-subdirs-app/config.rb +6 -3
- data/fixtures/blog-sources-subdirs-app/source/blog.html.erb +6 -3
- data/fixtures/blog-sources-subdirs-app/source/blog/another-post.html.markdown +9 -0
- data/fixtures/blog-sources-subdirs-app/source/blog/subdir/yet-another-post.html.markdown +9 -0
- data/fixtures/blog-sources-subdirs-app/source/layout.erb +24 -1
- data/fixtures/calendar-app/config-directory-indexes.rb +6 -4
- data/fixtures/calendar-app/config-only-year.rb +8 -6
- data/fixtures/calendar-app/config.rb +6 -4
- data/fixtures/calendar-app/source/layout.erb +17 -12
- data/fixtures/language-app/locales/en.yml +5 -4
- data/fixtures/language-app/locales/ru.yml +5 -4
- data/fixtures/language-app/source/2013-09-05-previous-english-article.html.erb +9 -0
- data/fixtures/language-app/source/2013-09-06-previous-russian-article.html.erb +9 -0
- data/fixtures/language-app/source/2013-09-07-english-article-with-lang-in-frontmatter.html.erb +5 -2
- data/fixtures/language-app/source/2013-09-07-russian-article-with-lang-in-frontmatter.html.erb +5 -2
- data/fixtures/language-app/source/2013-09-08-next-russian-article.html.erb +9 -0
- data/fixtures/language-app/source/2013-09-09-next-english-article.html.erb +9 -0
- data/fixtures/language-app/source/layouts/layout.erb +12 -1
- data/fixtures/language-app/source/localizable/index.html.erb +3 -1
- data/fixtures/layouts-app/source/2011/01/01/fourth-article.html.markdown +7 -0
- data/fixtures/paginate-app/config-directory-indexes.rb +14 -12
- data/fixtures/paginate-app/config-paginate-off.rb +14 -12
- data/fixtures/paginate-app/config.rb +16 -13
- data/fixtures/permalink-app/config.rb +7 -0
- data/fixtures/permalink-app/source/index.html.erb +13 -0
- data/fixtures/permalink-app/source/layout.erb +26 -0
- data/fixtures/permalink-app/source/news/2011-01-01-new-article.html.markdown +9 -0
- data/fixtures/summary-app/source/2013-05-08-article-with-custom-separator.html.markdown +1 -1
- data/fixtures/summary-app/source/2016-05-21-article-with-comment-separator.html.markdown +7 -0
- data/fixtures/tags-app/config-directory-indexes.rb +2 -1
- data/fixtures/tags-app/config-filters.rb +8 -0
- data/fixtures/tags-app/config-no-tags.rb +5 -3
- data/fixtures/tags-app/config.rb +2 -1
- data/fixtures/tags-app/source/blog/2011-01-03-no-taga.html.markdown +6 -0
- data/lib/middleman-blog.rb +7 -4
- data/lib/middleman-blog/blog_article.rb +157 -34
- data/lib/middleman-blog/blog_data.rb +83 -29
- data/lib/middleman-blog/calendar_pages.rb +1 -1
- data/lib/middleman-blog/commands/article.rb +88 -30
- data/lib/middleman-blog/commands/article.tt +4 -1
- data/lib/middleman-blog/custom_pages.rb +1 -1
- data/lib/middleman-blog/helpers.rb +2 -2
- data/lib/middleman-blog/paginator.rb +5 -4
- data/lib/middleman-blog/tag_pages.rb +61 -24
- data/lib/middleman-blog/truncate_html.rb +4 -9
- data/lib/middleman-blog/uri_templates.rb +44 -30
- data/lib/middleman-blog/version.rb +3 -1
- data/middleman-blog.gemspec +19 -17
- data/spec/spec_helper.rb +1 -1
- data/spec/uri_templates_spec.rb +21 -6
- metadata +68 -52
- data/.gemtest +0 -0
- data/features/no_date.feature +0 -9
- data/features/permalink-data.feature +0 -12
- data/fixtures/blog-sources-app/source/_article_template.erb +0 -1
- data/fixtures/blog-sources-subdirs-app/source/blog/another-post.html.md.erb +0 -8
- data/fixtures/blog-sources-subdirs-app/source/blog/subdir/yet-another-post.html.md.erb +0 -8
- data/fixtures/no-date-app/config.rb +0 -3
- data/fixtures/no-date-app/source/_article_template.erb +0 -1
- data/fixtures/no-date-app/source/blog/new-article.html.markdown +0 -6
- data/fixtures/no-date-app/source/index.html.erb +0 -9
- data/fixtures/no-day-app/config.rb +0 -3
- data/fixtures/no-day-app/source/2012-08-testing.html.markdown +0 -6
- data/fixtures/no-day-app/source/layout.erb +0 -13
- data/fixtures/no-title-app/source/2013-08-07.html.markdown +0 -6
- data/fixtures/no-title-app/source/2013-08-08.html.markdown +0 -7
- data/fixtures/no-title-app/source/layout.erb +0 -13
- data/fixtures/permalink-data-app/config.rb +0 -5
- data/fixtures/permalink-data-app/source/index.html.erb +0 -3
- data/fixtures/permalink-data-app/source/layout.erb +0 -14
- data/fixtures/permalink-data-app/source/news/2011-01-01-new-article.html.markdown +0 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bb18830e698dff563dc55d64242eea72fb69db75
|
4
|
+
data.tar.gz: 3a1363542c53cbf03e10c425b8c4c051d6e2f466
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 54188f4ae4228dc2b5242435bb3cd2d2f4ad8eea48b18cb3b018f7af39439f19de4fd2952261445c32302917ebd351b7e075c460d6cf82ed2e9200f7531cf363
|
7
|
+
data.tar.gz: c8051538355b5b6cea843c8293dcbf0815fef79f79c2d42164ed4fd9d56bd5987f89d12c06f7dc5994bb9cc199b73c009efb571659fd701bbe09bef96561cebf
|
data/.editorconfig
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# editorconfig.org
|
2
|
+
root = true
|
3
|
+
|
4
|
+
[*]
|
5
|
+
indent_style = space
|
6
|
+
indent_size = 2
|
7
|
+
charset = utf-8
|
8
|
+
trim_trailing_whitespace = true
|
9
|
+
insert_final_newline = true
|
10
|
+
end_of_line = lf
|
11
|
+
|
12
|
+
# editorconfig-tools is unable to ignore longs strings or urls
|
13
|
+
max_line_length = null
|
14
|
+
|
15
|
+
[*.md]
|
16
|
+
trim_trailing_whitespace = false
|
data/.gitignore
CHANGED
data/.travis.yml
CHANGED
@@ -1,24 +1,38 @@
|
|
1
|
-
|
1
|
+
##
|
2
|
+
# Travis YAML
|
3
|
+
##
|
4
|
+
|
5
|
+
language : ruby
|
6
|
+
sudo : false
|
7
|
+
cache : bundler
|
8
|
+
|
9
|
+
before_script :
|
10
|
+
- bundle update
|
11
|
+
|
12
|
+
rvm :
|
2
13
|
- ruby-head
|
3
|
-
-
|
4
|
-
-
|
5
|
-
- 2.2.
|
6
|
-
|
7
|
-
|
8
|
-
os:
|
14
|
+
- 2.4.0
|
15
|
+
- 2.3.1
|
16
|
+
- 2.2.4
|
17
|
+
|
18
|
+
os :
|
9
19
|
- linux
|
10
|
-
- osx
|
11
|
-
|
12
|
-
matrix:
|
13
|
-
fast_finish: true
|
14
|
-
allow_failures:
|
15
|
-
- rvm: ruby-head
|
16
|
-
|
17
|
-
|
20
|
+
# - osx
|
21
|
+
|
22
|
+
matrix :
|
23
|
+
fast_finish : true
|
24
|
+
allow_failures :
|
25
|
+
- rvm : ruby-head
|
26
|
+
|
27
|
+
# gemfile:
|
28
|
+
# - Gemfile
|
18
29
|
|
19
|
-
|
20
|
-
- Gemfile
|
30
|
+
script : bundle exec rake test
|
21
31
|
|
22
|
-
|
32
|
+
env :
|
33
|
+
global :
|
34
|
+
- TEST=true
|
35
|
+
# - CODECLIMATE_REPO_TOKEN=81787f7b1c3bfa937edadcafbc94f807bf5af5c1142c7b793f2d9969a271de1f
|
23
36
|
|
24
|
-
|
37
|
+
# notifications :
|
38
|
+
# slack : middleman:JW9OvXmn1m3XrSERe8866nBR
|
data/.yardopts
CHANGED
@@ -1,3 +1,3 @@
|
|
1
|
-
lib/**/*.rb
|
1
|
+
lib/**/*.rb
|
2
2
|
--no-private
|
3
|
-
--hide-void-return
|
3
|
+
--hide-void-return
|
data/CHANGELOG.md
CHANGED
@@ -1,15 +1,48 @@
|
|
1
|
-
|
2
|
-
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
$ gem build middleman-blog.gemspec
|
4
|
+
$ gem push middleman-blog-4.0.2.gem
|
5
|
+
|
6
|
+
## 4.0.3
|
7
|
+
|
8
|
+
*
|
9
|
+
|
10
|
+
## 4.0.2
|
11
|
+
|
12
|
+
* Pushed Gem 2017-05-22
|
13
|
+
* Updated safe_parameterize - needs heavy testing from community
|
14
|
+
* Deprecating previous_article and next_article in favour of article_previous article_next
|
15
|
+
* Deprecating local_articles in favour of articles_by_locale
|
16
|
+
* Pull request #336 Add article_locale_next and article_locale_previous
|
17
|
+
* Pull request #312 Generating a blog article can optional create article subdirectory added manually
|
18
|
+
* Updated Gemfile for testing tools to remove the deprecation warnings from Aruba
|
19
|
+
* Added myself to GemSpec so I can push Gem live
|
20
|
+
* Edited Travis.yml to be inline with middleman core and the Ruby versions it tests against
|
21
|
+
* Created an GitHub Issue Template
|
22
|
+
* Created an Editor config
|
23
|
+
* Ruby 2.3.1 - middleman-core (master/4.2.1) - middleman-cli (master/4.2.1) - middleman-blog (local) - All tests pass
|
24
|
+
* Updated the Gemfile to use https to remove security warning - upped gem versions to match core
|
25
|
+
* Updated the license and readme
|
26
|
+
|
27
|
+
## 4.0.1
|
28
|
+
|
29
|
+
* Pull in article command from v3.5.3 tag
|
30
|
+
* Summary fix
|
31
|
+
* Add address parse cache
|
32
|
+
* Add filter option
|
33
|
+
* Make sure to not generate invalid html when creating article summary
|
34
|
+
* If a summary_generator is defined, always use it to generate summaries
|
35
|
+
* Fix issue #269: duplicated key
|
36
|
+
|
37
|
+
## 4.0.0.rc.1
|
3
38
|
|
4
39
|
* Removed `article` sub command.
|
5
40
|
|
6
|
-
3.5.3
|
7
|
-
===
|
41
|
+
## 3.5.3
|
8
42
|
|
9
43
|
* Update blog_article active_support requires. Fixes #205
|
10
44
|
|
11
|
-
3.5.2
|
12
|
-
===
|
45
|
+
## 3.5.2
|
13
46
|
|
14
47
|
* Ignored pages won't be processed by the blog extension.
|
15
48
|
* Avoid creating an empty-string collection when a post does not have a custom collection property set. #192
|
@@ -18,16 +51,14 @@
|
|
18
51
|
* An article's language can be set via the {lang} parameter in its sources URL template. #187
|
19
52
|
* Tags that are just a number work now. #188
|
20
53
|
|
21
|
-
3.5.1
|
22
|
-
===
|
54
|
+
## 3.5.1
|
23
55
|
|
24
56
|
* Remove a broken bracket in the blog template. #181
|
25
57
|
* Fix transliteration of strings into URL slugs to still transliterate when it can but not smash multibyte chars. #183
|
26
58
|
* Only match source URI templates if the date components match what a date would look like, and avoid throwing when companion files do not have an article. #184
|
27
59
|
* Re-support spaces in blog article source paths. #185
|
28
60
|
|
29
|
-
3.5.0
|
30
|
-
===
|
61
|
+
## 3.5.0
|
31
62
|
|
32
63
|
* Add support for internationalization and locale-specific articles. #156
|
33
64
|
* Drop support for Ruby 1.8 and Middleman 3.0.
|
@@ -40,13 +71,11 @@
|
|
40
71
|
* The template used to generate new articles via "middleman article" can be overridden by setting :new_article_template.
|
41
72
|
* Removed `:blog_name`, `:blog_author`, `:blog_avatar` options and the `page_title` helper.
|
42
73
|
|
43
|
-
3.4.1
|
44
|
-
====
|
74
|
+
## 3.4.1
|
45
75
|
|
46
76
|
* Require Middleman 3.2
|
47
77
|
|
48
|
-
3.4.0
|
49
|
-
====
|
78
|
+
## 3.4.0
|
50
79
|
|
51
80
|
* Add `inspect` methods to `BlogData` and `BlogArticle` to avoid hangs on exceptions. #157
|
52
81
|
* Generated feed.xml now works on blogs with no posts. #155
|
@@ -55,8 +84,7 @@
|
|
55
84
|
* Support for including arbitrary frontmatter data in blog permalinks. #164
|
56
85
|
* When using multiblog, fail immediately if the blog name isn't specified. #168
|
57
86
|
|
58
|
-
3.3.0
|
59
|
-
====
|
87
|
+
## 3.3.0
|
60
88
|
|
61
89
|
* Experimental support for multiple blogs in a single site by activating
|
62
90
|
`:blog` multiple times.
|
@@ -78,8 +106,7 @@
|
|
78
106
|
* Pages can choose which blog to use in multi-blog mode by specifying the correct
|
79
107
|
blog in frontmatter. #150
|
80
108
|
|
81
|
-
3.2.0
|
82
|
-
====
|
109
|
+
## 3.2.0
|
83
110
|
|
84
111
|
* The `summary` method on articles is now HTML-aware, and can be provided with
|
85
112
|
a different summary length or ellipsis string: `summary(1000, '…')`.
|
@@ -91,13 +118,13 @@
|
|
91
118
|
* The `summary_separator` option no longer needs to have a capturing group, or
|
92
119
|
even be a regexp.
|
93
120
|
|
94
|
-
3.1.1
|
95
|
-
|
121
|
+
## 3.1.1
|
122
|
+
|
96
123
|
* Correctly handle time zone, allow setting time zone with `set :time_zone`. #76
|
97
124
|
* Fix using `page_articles` in when `paginate` is false. #78
|
98
125
|
|
99
|
-
3.1.0
|
100
|
-
|
126
|
+
## 3.1.0
|
127
|
+
|
101
128
|
* Don't publish future-dated articles. #74
|
102
129
|
* Create summary from source instead of output. #70
|
103
130
|
* Deprecate instance variables in templates in favor of locals. #66
|
@@ -108,8 +135,8 @@
|
|
108
135
|
* Use `link_to` in blog templates. #62
|
109
136
|
* Pagination for index, tag, and calendar pages. #57
|
110
137
|
|
111
|
-
3.0.0
|
112
|
-
|
138
|
+
## 3.0.0
|
139
|
+
|
113
140
|
* Middleman-3.0 compatible release. Complete overhaul.
|
114
141
|
* Tag and calendar pages.
|
115
142
|
* Sitemap integration.
|
data/CONTRIBUTING.md
CHANGED
@@ -1,4 +1,5 @@
|
|
1
1
|
# Contributing
|
2
|
+
|
2
3
|
In the spirit of [free software][free-sw], **everyone** is encouraged to help
|
3
4
|
improve this project.
|
4
5
|
|
@@ -6,12 +7,12 @@ improve this project.
|
|
6
7
|
|
7
8
|
Here are some ways *you* can contribute:
|
8
9
|
|
9
|
-
* by using alpha, beta, and
|
10
|
+
* by using alpha, beta, and pre-release versions
|
10
11
|
* by reporting bugs
|
11
12
|
* by suggesting new features
|
12
13
|
* by writing or editing documentation
|
13
14
|
* by writing specifications
|
14
|
-
* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent
|
15
|
+
* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent white space )
|
15
16
|
* by refactoring code
|
16
17
|
* by closing [issues][]
|
17
18
|
* by reviewing patches
|
@@ -19,6 +20,7 @@ Here are some ways *you* can contribute:
|
|
19
20
|
[issues]: https://github.com/middleman/middleman-blog/issues
|
20
21
|
|
21
22
|
## Submitting an Issue
|
23
|
+
|
22
24
|
We use the [GitHub issue tracker][issues] to track bugs and features. Before
|
23
25
|
submitting a bug report or feature request, check to make sure it hasn't
|
24
26
|
already been submitted. When submitting a bug report, please include a [Gist][]
|
@@ -29,6 +31,7 @@ Ideally, a bug report should include a pull request with failing specs.
|
|
29
31
|
[gist]: https://gist.github.com/
|
30
32
|
|
31
33
|
## Submitting a Pull Request
|
34
|
+
|
32
35
|
1. [Fork the repository.][fork]
|
33
36
|
2. [Create a topic branch.][branch]
|
34
37
|
3. Add specs for your unimplemented feature or bug fix.
|
data/Gemfile
CHANGED
@@ -1,31 +1,38 @@
|
|
1
|
+
##
|
2
|
+
# If you do not have OpenSSL installed, change
|
3
|
+
# the following line to use 'http://'
|
4
|
+
##
|
1
5
|
source 'https://rubygems.org'
|
2
6
|
|
3
|
-
|
4
|
-
gem "middleman-
|
7
|
+
# Middleman Gems
|
8
|
+
gem "middleman-cli", git: "https://github.com/middleman/middleman.git", branch: 'master'
|
9
|
+
gem "middleman-core", git: "https://github.com/middleman/middleman.git", branch: 'master'
|
5
10
|
|
6
11
|
# Specify your gem's dependencies in middleman-blog.gemspec
|
7
12
|
gemspec
|
8
13
|
|
9
14
|
# Build and doc tools
|
10
|
-
gem 'rake', '~> 10.3', require: false
|
11
|
-
gem 'yard', '~> 0.8',
|
15
|
+
gem 'rake', '~> 10.3', require: false # Latest 12.0.0
|
16
|
+
gem 'yard', '~> 0.8', require: false # Latest 0.9.8
|
12
17
|
|
13
18
|
# Test tools
|
14
|
-
gem 'pry',
|
15
|
-
gem 'aruba',
|
16
|
-
gem '
|
17
|
-
gem '
|
19
|
+
gem 'pry', '~> 0.10', require: false, group: :development # Latest 1.0.0.pre1
|
20
|
+
gem 'aruba', '~> 0.7.4', require: false # Latest 0.14.2
|
21
|
+
gem 'capybara', '~> 2.5.0', require: false # Latest 2.13.0 middleman-core forces all plugins to declare this
|
22
|
+
gem 'rspec', '~> 3.0', require: false # Latest 3.6.0.beta2
|
23
|
+
gem 'cucumber', '~> 2.4', require: false # Latest 3.0.0.pre.1
|
18
24
|
|
19
|
-
gem "timecop",
|
20
|
-
gem "nokogiri"
|
21
|
-
gem "kramdown"
|
25
|
+
gem "timecop", "~> 0.6.3" # Latest 0.8.1
|
26
|
+
gem "nokogiri" # Latest 1.7.1
|
27
|
+
gem "kramdown" # Latest 1.13.2
|
22
28
|
|
23
29
|
# Code Quality
|
24
|
-
gem 'rubocop',
|
25
|
-
gem 'simplecov',
|
26
|
-
gem 'coveralls',
|
27
|
-
gem 'codeclimate-test-reporter', '~> 0.3',
|
30
|
+
gem 'rubocop', '~> 0.24', require: false # Latest 0.47.1
|
31
|
+
gem 'simplecov', '~> 0.10', require: false # Latest 0.14.1
|
32
|
+
gem 'coveralls', '~> 0.8', require: false # Latest 0.8.19
|
33
|
+
gem 'codeclimate-test-reporter', '~> 0.3', require: false, group: :test # Latest 1.0.8
|
28
34
|
|
35
|
+
# Set the ruby platform - not windows
|
29
36
|
platforms :ruby do
|
30
|
-
gem "redcarpet", "~> 3.0
|
37
|
+
gem "redcarpet", "~> 3.1" # Latest 3.4.0
|
31
38
|
end
|
data/ISSUE_TEMPLATE.md
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
## Expected behaviour
|
2
|
+
|
3
|
+
## Actual behaviour
|
4
|
+
|
5
|
+
## Steps to reproduce the problem
|
6
|
+
|
7
|
+
- Please provide a repository or some tests we can run through
|
8
|
+
|
9
|
+
## Additional information
|
10
|
+
|
11
|
+
- Ruby version:
|
12
|
+
- Middleman version:
|
13
|
+
- Middleman Blog version:
|
14
|
+
- OS version:
|
data/LICENSE.md
CHANGED
@@ -1,20 +1,18 @@
|
|
1
|
-
Copyright (c) 2010-
|
1
|
+
Copyright (c) 2010-2017 Thomas Reynolds
|
2
2
|
|
3
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
the following conditions:
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
4
|
+
this software and associated documentation files (the "Software"), to deal in
|
5
|
+
the Software without restriction, including without limitation the rights to
|
6
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
7
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
8
|
+
subject to the following conditions:
|
10
9
|
|
11
|
-
The above copyright notice and this permission notice shall be
|
12
|
-
|
10
|
+
The above copyright notice and this permission notice shall be included in all
|
11
|
+
copies or substantial portions of the Software.
|
13
12
|
|
14
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
15
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
16
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
17
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
18
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
CHANGED
@@ -1,27 +1,36 @@
|
|
1
|
-
# Middleman-Blog
|
1
|
+
# Middleman-Blog extension
|
2
2
|
|
3
|
-
|
3
|
+
middleman-blog is an extension for the [Middleman] static site generator that
|
4
|
+
adds blog-specific functionality. This includes :
|
5
|
+
|
6
|
+
- Handling blog articles
|
7
|
+
- Helpers for listing articles
|
8
|
+
- Tagging support
|
4
9
|
|
5
10
|
## Installation
|
6
11
|
|
7
|
-
If you're just getting started, install the `middleman` gem and generate a new
|
12
|
+
If you're just getting started, install the `middleman` gem and generate a new
|
13
|
+
project:
|
8
14
|
|
9
15
|
```
|
10
16
|
gem install middleman
|
11
17
|
middleman init MY_PROJECT --template=blog
|
12
18
|
```
|
13
19
|
|
14
|
-
If you already have a Middleman project: Add `gem "middleman-blog"` to your
|
20
|
+
If you already have a Middleman project: Add `gem "middleman-blog"` to your
|
21
|
+
`Gemfile` and run `bundle install`
|
15
22
|
|
16
23
|
## Configuration
|
17
24
|
|
25
|
+
Within the config.rb of the middleman project, include the line
|
26
|
+
|
18
27
|
```
|
19
28
|
activate :blog
|
20
29
|
```
|
21
30
|
|
22
|
-
|
23
|
-
|
24
|
-
|
31
|
+
A more extensive guide can be found here :
|
32
|
+
[Middleman blogging guide](http://middlemanapp.com/basics/blogging/) it includes
|
33
|
+
more detailed information on configuring and using the blog extension.
|
25
34
|
|
26
35
|
Additionally, up-to-date generated code documentation is available on [RubyDoc].
|
27
36
|
|
@@ -32,30 +41,59 @@ Additionally, up-to-date generated code documentation is available on [RubyDoc].
|
|
32
41
|
[![Dependency Status](https://gemnasium.com/middleman/middleman-blog.svg?travis)][gemnasium]
|
33
42
|
[![Code Quality](https://codeclimate.com/github/middleman/middleman-blog.svg)][codeclimate]
|
34
43
|
[![Code Coverage](https://coveralls.io/repos/middleman/middleman-blog/badge.svg?branch=master)][coveralls]
|
44
|
+
|
35
45
|
## Community
|
36
46
|
|
37
|
-
|
47
|
+
Please also visit the the official [Middleman community forum](http://forum.middlemanapp.com)
|
38
48
|
|
39
49
|
## Bug Reports
|
40
50
|
|
41
|
-
Github Issues are used for managing bug reports and feature requests.
|
51
|
+
Github Issues are used for managing bug reports and feature requests.
|
52
|
+
|
53
|
+
If you run into issues or have an idea; please search and then submit the ticket
|
54
|
+
[here](https://github.com/middleman/middleman-blog/issues)
|
55
|
+
|
56
|
+
The best way to get quick responses to your issues and swift fixes to your bugs
|
57
|
+
is to submit detailed bug reports, include test cases and respond to developer
|
58
|
+
questions in a timely manner. Even better, if you know Ruby, you can submit
|
59
|
+
[Pull Requests](https://help.github.com/articles/using-pull-requests) containing
|
60
|
+
Cucumber Features which describe how your feature should work or exploit the bug
|
61
|
+
you are submitting.
|
62
|
+
|
63
|
+
## Testing
|
42
64
|
|
43
|
-
|
65
|
+
Our internal tests are passed through Travis, testing against the following
|
66
|
+
Ruby versions on Linux :
|
44
67
|
|
45
|
-
|
68
|
+
- ruby-head
|
69
|
+
- 2.4.0
|
70
|
+
- 2.3.1
|
71
|
+
- 2.2.4
|
72
|
+
|
73
|
+
### Running tests
|
46
74
|
|
47
75
|
1. Checkout Repository: `git clone https://github.com/middleman/middleman-blog.git`
|
48
76
|
2. Install Bundler: `gem install bundler`
|
49
77
|
3. Run `bundle install` inside the project root to install the gem dependencies.
|
50
78
|
4. Run test cases: `bundle exec rake test`
|
51
79
|
|
80
|
+
NB// To run an individual test use :
|
81
|
+
|
82
|
+
1. `bundle exec cucumber features/blog_sources.feature`
|
83
|
+
|
84
|
+
If you have suggestions for testing practices please submit a request.
|
85
|
+
|
86
|
+
## Creating documentation
|
87
|
+
|
88
|
+
1. `bundle exec rake doc`
|
89
|
+
|
52
90
|
## Donate
|
53
91
|
|
54
|
-
[Click here to lend your support to Middleman](https://
|
92
|
+
[Click here to lend your support to Middleman](https://plasso.com/s/4dXbHBorC3)
|
55
93
|
|
56
94
|
## License
|
57
95
|
|
58
|
-
Copyright (c) 2010-
|
96
|
+
Copyright (c) 2010-2017 Thomas Reynolds. MIT Licensed, see [LICENSE] for details.
|
59
97
|
|
60
98
|
[middleman]: http://middlemanapp.com
|
61
99
|
[gem]: https://rubygems.org/gems/middleman-blog
|
@@ -63,5 +101,5 @@ Copyright (c) 2010-2013 Thomas Reynolds. MIT Licensed, see [LICENSE] for details
|
|
63
101
|
[gemnasium]: https://gemnasium.com/middleman/middleman-blog
|
64
102
|
[codeclimate]: https://codeclimate.com/github/middleman/middleman-blog
|
65
103
|
[coveralls]: https://coveralls.io/r/middleman/middleman-blog
|
66
|
-
[rubydoc]: http://rubydoc.info/github/middleman/middleman-blog
|
104
|
+
[rubydoc]: http://rubydoc.info/github/middleman/middleman-blog/master
|
67
105
|
[LICENSE]: https://github.com/middleman/middleman-blog/blob/master/LICENSE.md
|