jekyll-readme-index 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/jekyll-readme-index/generator.rb +16 -2
- data/lib/jekyll-readme-index/version.rb +1 -1
- metadata +23 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c00724343a60e9a38cb622932d0f1cd0bd5daa4c4ae9a8cde7145b7f10c2788b
|
|
4
|
+
data.tar.gz: 6e6c62f3bf22e22872a2e53b4f1006b671b5ad2ef22b8eeab4d0b31ac76992e3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2bb3b1c0f56d05d107e82365db2295f428a4e4c95de15b2a1bcb61a1d0a4d8bfae56bd75e3ff4bebc5c1a871a575915f024b82affe2775509af88f64e8671cc7
|
|
7
|
+
data.tar.gz: 94af6895f20cbce0fe4a758968cd0c2b98dae550fe3e913c1f4237528060a0108e01b135626f778a8b57d07cedb55e147b840c895209ff9bb149181adf590768
|
|
@@ -23,6 +23,7 @@ module JekyllReadmeIndex
|
|
|
23
23
|
CLEANUP_KEY = "remove_originals"
|
|
24
24
|
FRONTMATTER_KEY = "with_frontmatter"
|
|
25
25
|
PATTERN_KEY = "readme_pattern"
|
|
26
|
+
APPEND_HTML_KEY = "append_html"
|
|
26
27
|
|
|
27
28
|
def initialize(site)
|
|
28
29
|
@site = site
|
|
@@ -104,7 +105,7 @@ module JekyllReadmeIndex
|
|
|
104
105
|
name = static_file.instance_variable_get(:@name)
|
|
105
106
|
page = Jekyll::Page.new(site, base, dir, name)
|
|
106
107
|
|
|
107
|
-
page.data["permalink"] =
|
|
108
|
+
page.data["permalink"] = target_permalink(static_file)
|
|
108
109
|
page
|
|
109
110
|
end
|
|
110
111
|
|
|
@@ -112,7 +113,11 @@ module JekyllReadmeIndex
|
|
|
112
113
|
def update_permalink(page)
|
|
113
114
|
# If URL already ends with '/', it's a directory URL and should be used as-is
|
|
114
115
|
url = page.url
|
|
115
|
-
page.data["permalink"] = url.end_with?("/")
|
|
116
|
+
page.data["permalink"] = if url.end_with?("/")
|
|
117
|
+
append_html? ? File.join(url, "index.html") : url
|
|
118
|
+
else
|
|
119
|
+
target_permalink(page)
|
|
120
|
+
end
|
|
116
121
|
# Page#url is memoized; drop it so it's rebuilt from the new permalink
|
|
117
122
|
page.instance_variable_set(:@url, nil)
|
|
118
123
|
page.url
|
|
@@ -126,6 +131,11 @@ module JekyllReadmeIndex
|
|
|
126
131
|
File.join(File.dirname(file.url), "/")
|
|
127
132
|
end
|
|
128
133
|
|
|
134
|
+
def target_permalink(file)
|
|
135
|
+
dir = target_dir(file)
|
|
136
|
+
append_html? ? File.join(dir, "index.html") : dir
|
|
137
|
+
end
|
|
138
|
+
|
|
129
139
|
# Check if this is a README in a special directory (.github or docs)
|
|
130
140
|
def special_readme?(file)
|
|
131
141
|
path = readme_path(file)
|
|
@@ -204,6 +214,10 @@ module JekyllReadmeIndex
|
|
|
204
214
|
option(FRONTMATTER_KEY) == true
|
|
205
215
|
end
|
|
206
216
|
|
|
217
|
+
def append_html?
|
|
218
|
+
option(APPEND_HTML_KEY) == true
|
|
219
|
+
end
|
|
220
|
+
|
|
207
221
|
# Helper method to get the file path (URL or path) for a file object
|
|
208
222
|
def file_path(file)
|
|
209
223
|
file.respond_to?(:url) ? file.url : "/" + file.path
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-readme-index
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.6.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ben Balter
|
|
@@ -43,6 +43,20 @@ dependencies:
|
|
|
43
43
|
- - "~>"
|
|
44
44
|
- !ruby/object:Gem::Version
|
|
45
45
|
version: '1.1'
|
|
46
|
+
- !ruby/object:Gem::Dependency
|
|
47
|
+
name: rake
|
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
|
49
|
+
requirements:
|
|
50
|
+
- - "~>"
|
|
51
|
+
- !ruby/object:Gem::Version
|
|
52
|
+
version: '13.0'
|
|
53
|
+
type: :development
|
|
54
|
+
prerelease: false
|
|
55
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
56
|
+
requirements:
|
|
57
|
+
- - "~>"
|
|
58
|
+
- !ruby/object:Gem::Version
|
|
59
|
+
version: '13.0'
|
|
46
60
|
- !ruby/object:Gem::Dependency
|
|
47
61
|
name: rspec
|
|
48
62
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -169,6 +183,8 @@ dependencies:
|
|
|
169
183
|
- - ">="
|
|
170
184
|
- !ruby/object:Gem::Version
|
|
171
185
|
version: '0'
|
|
186
|
+
description: Jekyll plugin that uses README.md as your site's index page, no index.md
|
|
187
|
+
needed. Supported on GitHub Pages.
|
|
172
188
|
email:
|
|
173
189
|
- ben.balter@github.com
|
|
174
190
|
executables: []
|
|
@@ -181,7 +197,11 @@ files:
|
|
|
181
197
|
homepage: https://github.com/benbalter/jekyll-readme-index
|
|
182
198
|
licenses:
|
|
183
199
|
- MIT
|
|
184
|
-
metadata:
|
|
200
|
+
metadata:
|
|
201
|
+
homepage_uri: https://github.com/benbalter/jekyll-readme-index
|
|
202
|
+
source_code_uri: https://github.com/benbalter/jekyll-readme-index
|
|
203
|
+
bug_tracker_uri: https://github.com/benbalter/jekyll-readme-index/issues
|
|
204
|
+
changelog_uri: https://github.com/benbalter/jekyll-readme-index/releases
|
|
185
205
|
rdoc_options: []
|
|
186
206
|
require_paths:
|
|
187
207
|
- lib
|
|
@@ -196,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
196
216
|
- !ruby/object:Gem::Version
|
|
197
217
|
version: '0'
|
|
198
218
|
requirements: []
|
|
199
|
-
rubygems_version:
|
|
219
|
+
rubygems_version: 4.0.20
|
|
200
220
|
specification_version: 4
|
|
201
221
|
summary: A Jekyll plugin to render a project's README as the site's index.
|
|
202
222
|
test_files: []
|