jekyll-asciidoc 3.0.0 → 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.adoc +13 -0
- data/Gemfile +12 -1
- data/{LICENSE.adoc → LICENSE} +1 -4
- data/README.adoc +85 -45
- data/jekyll-asciidoc.gemspec +6 -8
- data/lib/jekyll-asciidoc/converter.rb +6 -3
- data/lib/jekyll-asciidoc/version.rb +1 -1
- metadata +19 -41
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ec2fbf892d456f3a8bd99b9ddc7a402c9fb2d0c97a9c75db95f21a06940dfb4a
|
4
|
+
data.tar.gz: b46881e3f2cb90201cae60abe45e7c7a4e45139ce0c47e2461fb7d9674960d54
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4bd45b214ab78e04d115c127a6c4b5ef02735a711eefde1ca116ebfc96b8b0bfd238e107722e665073fbd5e5876416eee8ea214812e77a752ec6ef8c190b2dbe
|
7
|
+
data.tar.gz: '0820e864821743154409895c604e090faf5759a5908fc92e70f7dcb0c86f680e01ed3eacaa19703d32a0a8317a1ca9e72d779c0dc497263071f15169853d8863'
|
data/CHANGELOG.adoc
CHANGED
@@ -5,6 +5,19 @@
|
|
5
5
|
This document provides a high-level view of the changes to the {project-name} by release.
|
6
6
|
For a detailed view of what has changed, refer to the {url-repo}/commits/master[commit history] on GitHub.
|
7
7
|
|
8
|
+
== 3.0.1 (2023-11-06) - @mojavelinux
|
9
|
+
|
10
|
+
* clear `:base_dir` option if value is `:docdir` and paths with docdir information is not available (such as to `asciidocify` filter) (#270)
|
11
|
+
* prepend baseurl to value of imagesdir if imagesdir value is root-relative (#177)
|
12
|
+
|
13
|
+
=== Details
|
14
|
+
|
15
|
+
{url-repo}/releases/tag/v3.0.1[git tag] | {url-repo}/compare/v3.0.0\...v3.0.1[full diff]
|
16
|
+
|
17
|
+
== 3.0.0 (2019-08-31) - @mojavelinux
|
18
|
+
|
19
|
+
_No changes since previous release._
|
20
|
+
|
8
21
|
== 3.0.0.beta.2 (2019-06-03) - @mojavelinux
|
9
22
|
|
10
23
|
* allow site-wide AsciiDoc attributes to also be defined on `asciidoc` key in site configuration (#126)
|
data/Gemfile
CHANGED
@@ -2,11 +2,22 @@ source 'https://rubygems.org'
|
|
2
2
|
|
3
3
|
gemspec
|
4
4
|
|
5
|
-
gem 'asciidoctor', ENV['ASCIIDOCTOR_VERSION'], require: false if ENV.key? 'ASCIIDOCTOR_VERSION'
|
5
|
+
gem 'asciidoctor', %(~> #{ENV['ASCIIDOCTOR_VERSION']}), require: false if ENV.key? 'ASCIIDOCTOR_VERSION'
|
6
|
+
gem 'em-websocket', '0.5.2', platform: [:jruby], require: false
|
6
7
|
gem 'jekyll', %(~> #{ENV['JEKYLL_VERSION']}), require: false if ENV.key? 'JEKYLL_VERSION'
|
8
|
+
gem 'pygments.rb', %(~> #{ENV['PYGMENTS_VERSION']}), require: false if ENV.key? 'PYGMENTS_VERSION'
|
7
9
|
# NOTE Windows does not include zoneinfo files, so load tzinfo-data gem
|
8
10
|
gem 'tzinfo-data', platform: [:x64_mingw, :mingw], require: false
|
9
11
|
|
12
|
+
group :coverage do
|
13
|
+
gem 'deep-cover-core', '~> 1.1.0', require: false
|
14
|
+
gem 'simplecov', '~> 0.18.0', require: false
|
15
|
+
end
|
16
|
+
|
10
17
|
group :docs do
|
11
18
|
gem 'yard', require: false
|
12
19
|
end
|
20
|
+
|
21
|
+
group :lint do
|
22
|
+
gem 'rubocop', '~> 0.74.0', require: false
|
23
|
+
end
|
data/{LICENSE.adoc → LICENSE}
RENAMED
@@ -1,6 +1,4 @@
|
|
1
|
-
|
2
|
-
....
|
3
|
-
Copyright (C) 2013-2018 Dan Allen, Paul Rayner, and the Asciidoctor Project
|
1
|
+
Copyright (C) 2013-present Dan Allen, Paul Rayner, and the Asciidoctor Project
|
4
2
|
|
5
3
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
4
|
of this software and associated documentation files (the "Software"), to deal
|
@@ -19,4 +17,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
17
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
18
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
19
|
THE SOFTWARE.
|
22
|
-
....
|
data/README.adoc
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
= Jekyll AsciiDoc Plugin (powered by Asciidoctor)
|
2
2
|
Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Paul Rayner <https://github.com/paulrayner[@paulrayner]>
|
3
|
-
v3.0.
|
3
|
+
v3.0.1, 2023-11-06
|
4
4
|
// Settings:
|
5
5
|
:idprefix:
|
6
6
|
:idseparator: -
|
@@ -11,6 +11,7 @@ ifdef::env-github,env-browser[]
|
|
11
11
|
endif::[]
|
12
12
|
ifdef::env-github[]
|
13
13
|
:status:
|
14
|
+
:branch: v3.0.x
|
14
15
|
:outfilesuffix: .adoc
|
15
16
|
:!toc-title:
|
16
17
|
:caution-caption: :fire:
|
@@ -27,17 +28,14 @@ ifndef::icons[:conum-guard: {sp}#{sp}]
|
|
27
28
|
:url-repo: https://github.com/asciidoctor/jekyll-asciidoc
|
28
29
|
:url-issues: {url-repo}/issues
|
29
30
|
:url-search-issues: {url-repo}/search?type=Issues
|
30
|
-
:url-chat: https://
|
31
|
-
:url-
|
32
|
-
:url-
|
33
|
-
:url-
|
34
|
-
:url-
|
35
|
-
:url-asciidoc: http://asciidoc.org
|
36
|
-
:url-asciidoctor: http://asciidoctor.org
|
31
|
+
:url-chat: https://chat.asciidoctor.org
|
32
|
+
:url-gem: https://rubygems.org/gems/jekyll-asciidoc
|
33
|
+
:url-gem-asciidoctor: https://rubygems.org/gems/asciidoctor
|
34
|
+
:url-asciidoc: https://asciidoc.org
|
35
|
+
:url-asciidoctor: https://asciidoctor.org
|
37
36
|
:url-asciidoctor-backends: https://github.com/asciidoctor/asciidoctor-backends
|
38
37
|
:url-asciidoctor-docs: {url-asciidoctor}/docs
|
39
38
|
:url-asciidoctor-diagram: {url-asciidoctor-docs}/asciidoctor-diagram
|
40
|
-
:url-asciidoctor-discuss: http://discuss.asciidoctor.org
|
41
39
|
:url-asciidoctor-manual: {url-asciidoctor-docs}/user-manual
|
42
40
|
:url-asciidoc-practices: {url-asciidoctor-docs}/asciidoc-recommended-practices
|
43
41
|
:url-jaq: https://github.com/asciidoctor/jekyll-asciidoc-quickstart
|
@@ -47,32 +45,20 @@ ifndef::icons[:conum-guard: {sp}#{sp}]
|
|
47
45
|
:url-front-matter: {url-jekyll-docs}/frontmatter
|
48
46
|
:url-liquid-templates: {url-jekyll-docs}/templates
|
49
47
|
:url-variables: {url-jekyll-docs}/variables
|
50
|
-
:url-graphviz:
|
48
|
+
:url-graphviz: https://www.graphviz.org
|
51
49
|
:url-tilt: https://github.com/rtomayko/tilt
|
52
50
|
:url-yaml: https://en.wikipedia.org/wiki/YAML
|
53
|
-
:url-guide-publish-gem:
|
51
|
+
:url-guide-publish-gem: https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg
|
54
52
|
|
55
53
|
ifdef::status[]
|
56
54
|
image:https://img.shields.io/gem/v/jekyll-asciidoc.svg[Latest Release, link={url-gem}]
|
57
55
|
image:https://img.shields.io/badge/license-MIT-blue.svg[MIT License, link=#copyright-and-license]
|
58
|
-
image:
|
59
|
-
image:https://
|
56
|
+
image:{url-repo}/actions/workflows/ci.yml/badge.svg?branch={branch}[Build Status (GitHub Actions),link={url-repo}/actions/workflows/ci.yml?query=branch%3A{branch}]
|
57
|
+
image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg[Project Chat (Zulip),link={url-chat}]
|
60
58
|
endif::[]
|
61
59
|
|
62
60
|
A plugin for {url-jekyll}[Jekyll] (>= 3.0.0) that converts {url-asciidoc}[AsciiDoc] source files in your site to HTML pages using {url-asciidoctor}[Asciidoctor].
|
63
61
|
|
64
|
-
ifeval::['{branch}' == 'master']
|
65
|
-
NOTE: You're viewing the documentation for the upcoming release.
|
66
|
-
If you're looking for the documentation for an older release, please refer to one of the following branches: +
|
67
|
-
{url-repo}/tree/v2.1.x#readme[2.1.x]
|
68
|
-
⁃
|
69
|
-
{url-repo}/tree/v2.0.x#readme[2.0.x]
|
70
|
-
⁃
|
71
|
-
{url-repo}/tree/v1.1.x#readme[1.1.x]
|
72
|
-
⁃
|
73
|
-
{url-repo}/tree/v1.0.x#readme[1.0.x]
|
74
|
-
endif::[]
|
75
|
-
|
76
62
|
toc::[]
|
77
63
|
|
78
64
|
== Overview
|
@@ -95,7 +81,7 @@ These extensions are registered automatically when the [.app]*jekyll-asciidoc* g
|
|
95
81
|
|
96
82
|
== Prerequisites
|
97
83
|
|
98
|
-
To use this plugin, you must be using Jekyll >= 3.0.0 and Ruby >= 2.
|
84
|
+
To use this plugin, you must be using Jekyll >= 3.0.0 and Ruby >= 2.4.0 (with development headers installed).
|
99
85
|
You should also be familiar with creating sites with Jekyll.
|
100
86
|
If you're not, you should first read the {url-jekyll-docs}[Jekyll documentation] to familiarize yourself with how it works.
|
101
87
|
Experience with AsciiDoc and Asciidoctor is also helpful, but not a requirement.
|
@@ -135,7 +121,8 @@ Jekyll will automatically activate any plugins listed in the `:jekyll_plugins` g
|
|
135
121
|
|
136
122
|
If you want to keep the installed gems inside the project, use this command instead:
|
137
123
|
|
138
|
-
$ bundle --path
|
124
|
+
$ bundle config set --local path .bundle/gems
|
125
|
+
bundle
|
139
126
|
|
140
127
|
TIP: Subsequent calls to `bundle` will retain the `path` setting.
|
141
128
|
|
@@ -167,6 +154,23 @@ gems:
|
|
167
154
|
- jekyll-asciidoc
|
168
155
|
----
|
169
156
|
|
157
|
+
=== Plugin Ordering
|
158
|
+
|
159
|
+
Since the [.app]*jekyll-asciidoc* plugin promotes <<page-attributes,page attributes>> to the front matter, it must run first.
|
160
|
+
To make sure it does, rearrange the sequence of plugins in your Gemfile or {path-config} file so the [.app]*jekyll-asciidoc* plugin is listed before other plugins.
|
161
|
+
By doing so, other plugins will be able to access any front matter that this plugin assigns.
|
162
|
+
|
163
|
+
Let's consider the case of using the [.app]*jekyll-archives* plugin alongside the [.app]*jekyll-asciidoc* plugin.
|
164
|
+
|
165
|
+
[source,ruby]
|
166
|
+
----
|
167
|
+
group :jekyll_plugins do
|
168
|
+
gem 'jekyll-asciidoc'
|
169
|
+
gem 'jekyll-archives' <1>
|
170
|
+
end
|
171
|
+
----
|
172
|
+
<1> The [.app]*jekyll-archives* plugin should be listed after the [.app]*jekyll-asciidoc* plugin since it needs to access front matter that is promoted from the header of the AsciiDoc document.
|
173
|
+
|
170
174
|
== Creating Pages
|
171
175
|
|
172
176
|
This plugin converts eligible AsciiDoc files located inside the source directory (by default, the project root) to HTML pages in the generated site.
|
@@ -187,7 +191,7 @@ layout: info
|
|
187
191
|
permalink: /sample/
|
188
192
|
---
|
189
193
|
= Sample Page
|
190
|
-
:url-asciidoctor:
|
194
|
+
:url-asciidoctor: https://asciidoctor.org
|
191
195
|
|
192
196
|
This is a sample page composed in AsciiDoc.
|
193
197
|
Jekyll converts it to HTML using {url-asciidoctor}[Asciidoctor].
|
@@ -204,7 +208,7 @@ Alternatively, you can define the page variables directly in the AsciiDoc header
|
|
204
208
|
= Sample Page
|
205
209
|
:page-layout: info
|
206
210
|
:page-permalink: /sample/
|
207
|
-
:url-asciidoctor:
|
211
|
+
:url-asciidoctor: https://asciidoctor.org
|
208
212
|
|
209
213
|
This is a sample page composed in AsciiDoc.
|
210
214
|
Jekyll converts it to HTML using {url-asciidoctor}[Asciidoctor].
|
@@ -237,11 +241,14 @@ To define a page attribute that contains multiple words, use either a hyphen or
|
|
237
241
|
IMPORTANT: Page attributes must be defined in the document header.
|
238
242
|
That means either putting them directly below the document title (the line beginning with a single equals sign in the sample above) or above all other AsciiDoc content if the document title is not defined in AsciiDoc.
|
239
243
|
The AsciiDoc document header stops after the first blank line.
|
240
|
-
For more details about the document header, see the
|
244
|
+
For more details about the document header, see the https://asciidoctor.org/docs/user-manual/#doc-header[Document Header] chapter in the Asciidoctor User Manual.
|
241
245
|
|
242
246
|
IMPORTANT: You may use include directives in the the document header.
|
243
247
|
However, you must ensure that the file included _does not_ contain blank lines.
|
244
248
|
|
249
|
+
CAUTION: If an attribute defined in the header of an AsciiDoc document is not visible to another plugin or Liquid template, you may have a plugin ordering problem.
|
250
|
+
See <<Plugin Ordering>> to learn how to fix it.
|
251
|
+
|
245
252
|
=== Specifying a Layout
|
246
253
|
|
247
254
|
The most commonly defined page variable is layout, which determines which template is used to wrap the generated content.
|
@@ -425,6 +432,16 @@ If you're using the Liquid include tag to include HTML into the AsciiDoc documen
|
|
425
432
|
This is necessary since AsciiDoc will escape HTML by default.
|
426
433
|
To pass it through raw requires enclosing it in a passthrough block.
|
427
434
|
|
435
|
+
=== Preventing Liquid Processing on AsciiDoc Includes
|
436
|
+
|
437
|
+
The Liquid preprocessor does not process content included using the AsciiDoc include directive.
|
438
|
+
However, if those files are otherwise publishable, they are processed independently by Jekyll with the Liquid preprocessor and will appear in your site.
|
439
|
+
If this is not the behavior you want, you can exclude them from being processed independently using one of the following techniques:
|
440
|
+
|
441
|
+
* Place them in an automatically excluded location, such as a directory starting with `_` (e.g. [.path]___includes__).
|
442
|
+
* Name them in such a way that they are automatically excluded, such as starting the name with `_` ([.path]___excluded-include.yml__).
|
443
|
+
* Adding them to the https://jekyllrb.com/docs/configuration/options/[excludes] key in the Jekyll configuration.
|
444
|
+
|
428
445
|
=== Extracting Excerpts
|
429
446
|
|
430
447
|
This plugin will extract an excerpt for any post or document in a collection if the `excerpt` page variable isn't set using the same logic as for Markdown files.
|
@@ -693,7 +710,7 @@ asciidoctor:
|
|
693
710
|
|
694
711
|
If, instead, you want the base directory to track the directory of the document being processed, and you're using Jekyll 3 or better, you can set the value of the `base_dir` option to `:docdir`.
|
695
712
|
This behavior matches how Asciidoctor works when running it outside of Jekyll.
|
696
|
-
Since the base directory is also the jail, we also recommend setting the `safe` option to
|
713
|
+
Since the base directory is also the jail, we also recommend setting the `safe` option to enable unsafe mode so you can still resolve paths outside of this directory.
|
697
714
|
|
698
715
|
[source,yaml]
|
699
716
|
----
|
@@ -847,6 +864,21 @@ content
|
|
847
864
|
content
|
848
865
|
----
|
849
866
|
|
867
|
+
By default, the `tocify_asciidoc` filter will insert a table of contents on any page that has even one section below the page title.
|
868
|
+
It's possible to conditionally disable this by using a Liquid `if` statement in your template with a custom attribute, similar to:
|
869
|
+
|
870
|
+
----
|
871
|
+
{% if page.show-toc != false %}
|
872
|
+
<div class="toc">
|
873
|
+
{{ page.document | tocify_asciidoc }}
|
874
|
+
</div>
|
875
|
+
{% endif %}
|
876
|
+
----
|
877
|
+
|
878
|
+
Then in the front matter of pages where you do not want a table of contents to appear, use the attribute `:page-show-toc: false`.
|
879
|
+
Note that since this example uses a custom attribute, its name can be anything you'd like, it only needs to start with with `page-`.
|
880
|
+
If you change the attribute name from this example, be sure to update the it in the `if` statement as appropriate.
|
881
|
+
|
850
882
|
== Customizing the Generated HTML
|
851
883
|
|
852
884
|
You can use templates to customize the HTML output that Asciidoctor generates for your site.
|
@@ -1103,7 +1135,7 @@ An alternative to the monkeypath approach is to identify folders that contain ge
|
|
1103
1135
|
|
1104
1136
|
[source,yaml]
|
1105
1137
|
----
|
1106
|
-
keep_files:
|
1138
|
+
keep_files:
|
1107
1139
|
- images
|
1108
1140
|
asciidoctor:
|
1109
1141
|
base_dir: :docdir
|
@@ -1196,7 +1228,7 @@ You need to augment the layout to include resources typically present in a stand
|
|
1196
1228
|
+
|
1197
1229
|
[source,html]
|
1198
1230
|
----
|
1199
|
-
<link rel="stylesheet" href="{{
|
1231
|
+
<link rel="stylesheet" href="{{ '/css/asciidoc.css' | prepend: site.baseurl }}">
|
1200
1232
|
----
|
1201
1233
|
|
1202
1234
|
=== Stylesheet for Code Highlighting
|
@@ -1208,11 +1240,9 @@ To do so, add the `pygments.rb` gem to your [.path]_Gemfile_:
|
|
1208
1240
|
|
1209
1241
|
[source,ruby]
|
1210
1242
|
----
|
1211
|
-
gem 'pygments.rb', '~>
|
1243
|
+
gem 'pygments.rb', '~> 2.3.0'
|
1212
1244
|
----
|
1213
1245
|
|
1214
|
-
IMPORTANT: To use Pygments with Ruby >= 2.4 or JRuby, you must install pygments.rb >= 1.1.0.
|
1215
|
-
|
1216
1246
|
As part of this integration, Asciidoctor generates a custom stylesheet tailored specially to work with the HTML that Asciidocotor produces.
|
1217
1247
|
Since this stylesheet is backed by the Pygments API, it provides access to all the themes in Pygments
|
1218
1248
|
|
@@ -1223,6 +1253,15 @@ This plugin will automatically generate a stylesheet for Pygments into the sourc
|
|
1223
1253
|
* `pygments-stylesheet` is not unset (if set, it can have any value)
|
1224
1254
|
|
1225
1255
|
By default, the stylesheet is written to `stylesdir` + `pygments-stylesheet`.
|
1256
|
+
If you want the stylesheet to be written to the [.path]_css_ directory, add the following configuration to your site's `_config.yml` file:
|
1257
|
+
|
1258
|
+
[source,yaml]
|
1259
|
+
----
|
1260
|
+
asciidoctor:
|
1261
|
+
attributes:
|
1262
|
+
stylesdir: css
|
1263
|
+
----
|
1264
|
+
|
1226
1265
|
If the `pygments-stylesheet` attribute is not specified, the value defaults to `asciidoc-pygments.css`.
|
1227
1266
|
You can customize this value to your liking.
|
1228
1267
|
|
@@ -1232,16 +1271,16 @@ If this attribute is not set, it defaults to `vs`.
|
|
1232
1271
|
The stylesheet file will be created if it does not yet exist or the theme has been changed.
|
1233
1272
|
Jekyll will handle copying the file to the output directory.
|
1234
1273
|
|
1235
|
-
You'll need to add a line to your template to link to this stylesheet, such as:
|
1274
|
+
You'll need to add a line to your template to link to this stylesheet (assuming `stylesdir=css`), such as:
|
1236
1275
|
|
1237
1276
|
[source,html]
|
1238
1277
|
----
|
1239
|
-
<link rel="stylesheet" href="{{
|
1278
|
+
<link rel="stylesheet" href="{{ '/css/asciidoc-pygments.css' | prepend: site.baseurl }}">
|
1240
1279
|
----
|
1241
1280
|
|
1242
1281
|
To disable this feature, either set the `pygments-css` to `style` (to enable inline styles) or unset the `pygments-stylesheet` attribute in your site's {path-config}.
|
1243
1282
|
|
1244
|
-
NOTE: It may still be necessary to make some tweaks to your site's stylesheet to
|
1283
|
+
NOTE: It may still be necessary to make some tweaks to your site's stylesheet to accommodate this integration.
|
1245
1284
|
|
1246
1285
|
=== Font-based Admonition and Inline Icons
|
1247
1286
|
|
@@ -1258,7 +1297,7 @@ Next, you need to add the following CSS rules from the default Asciidoctor style
|
|
1258
1297
|
|
1259
1298
|
[source,css]
|
1260
1299
|
----
|
1261
|
-
span.icon
|
1300
|
+
span.icon > .fa {
|
1262
1301
|
cursor: default;
|
1263
1302
|
}
|
1264
1303
|
.admonitionblock td.icon {
|
@@ -1312,6 +1351,8 @@ asciidoctor:
|
|
1312
1351
|
...
|
1313
1352
|
----
|
1314
1353
|
|
1354
|
+
==== Circled Callout Numbers
|
1355
|
+
|
1315
1356
|
Circled callout numbers are also linked to the `icons=font` setting, even though they don't rely on the Font Awesome font.
|
1316
1357
|
To enable them, you need to add the following additional CSS to the [.path]_css/asciidoc.css_ file:
|
1317
1358
|
|
@@ -1393,7 +1434,7 @@ Refer to the help page https://help.github.com/articles/adding-jekyll-plugins-to
|
|
1393
1434
|
|
1394
1435
|
_But don't despair!_
|
1395
1436
|
You can still automate publishing of the generated site to GitHub Pages using a continuous integration job.
|
1396
|
-
Refer to the
|
1437
|
+
Refer to the https://eshepelyuk.github.io/2014/10/28/automate-github-pages-travisci.html[Automate GitHub Pages publishing with Jekyll and Travis CI^] tutorial to find step-by-step instructions.
|
1397
1438
|
You can also refer to the https://github.com/johncarl81/transfuse-site[Transfuse website build^] for an example in practice.
|
1398
1439
|
|
1399
1440
|
In fact, if you're using Travis CI, it's even easier than that.
|
@@ -1437,7 +1478,7 @@ Refer to the https://phlow.github.io/feeling-responsive/getting-started/[Getting
|
|
1437
1478
|
Deployment to GitLab Pages is much simpler.
|
1438
1479
|
That's because GitLab allows you to control the execution of Jekyll yourself.
|
1439
1480
|
There's no need to mess around with CI jobs and authentication tokens.
|
1440
|
-
You can find all about how to use Jekyll with GitLab Pages in the tutorial https://about.gitlab.com/2016/04/07/gitlab-pages-setup/#option-b-gitlab-ci-for-jekyll-websites[Hosting on GitLab.com with GitLab Pages].
|
1481
|
+
You can find all about how to use Jekyll with GitLab Pages in the tutorial https://about.gitlab.com/2016/04/07/gitlab-pages-setup/#option-b-gitlab-ci-for-jekyll-websites[Hosting on GitLab.com with GitLab Pages].
|
1441
1482
|
More in-depth information regarding setting up your repository for GitLab Pages can be found in the https://docs.gitlab.com/ee/pages/README.html[GitLab Enterprise Edition / Pages] documentation.
|
1442
1483
|
|
1443
1484
|
Assuming the following are true:
|
@@ -1496,8 +1537,7 @@ Activity drives progress.
|
|
1496
1537
|
|
1497
1538
|
When seeking answers, always start with the official documentation for Jekyll, which can be found on the {url-jekyll}[Jekyll website].
|
1498
1539
|
If you have general questions about Jekyll, we recommend you visit the {url-jekyll-discuss}[Jekyll Talk] forum to get assistance.
|
1499
|
-
For questions related to this extension specifically, or general questions about AsciiDoc, please post to the {url-
|
1500
|
-
You can also join us in the {url-chat}[asciidoctor/asciidoctor channel] on Gitter.
|
1540
|
+
For questions related to this extension specifically, or general questions about AsciiDoc or Asciidoctor, please post to the #users stream in the {url-chat}[project chat].
|
1501
1541
|
For general information about AsciiDoc, look no further than the {url-asciidoctor-manual}[Asciidoctor User Manual].
|
1502
1542
|
|
1503
1543
|
=== Filing Bug Reports and Feature Requests
|
@@ -1673,7 +1713,7 @@ This plugin was created by Dan Allen and Paul Rayner and has received contributi
|
|
1673
1713
|
|
1674
1714
|
Copyright (C) 2013-2018 Dan Allen, Paul Rayner, and the Asciidoctor Project.
|
1675
1715
|
Free use of this software is granted under the terms of the MIT License.
|
1676
|
-
See
|
1716
|
+
See link:LICENSE[LICENSE] for details.
|
1677
1717
|
|
1678
1718
|
////
|
1679
1719
|
[glossary]
|
data/jekyll-asciidoc.gemspec
CHANGED
@@ -27,18 +27,16 @@ Gem::Specification.new do |s|
|
|
27
27
|
rescue ::SystemCallError
|
28
28
|
Dir['**/*']
|
29
29
|
end
|
30
|
-
s.files = files.grep %r/^(?:lib\/.+|Gemfile|(?:CHANGELOG|
|
30
|
+
s.files = files.grep %r/^(?:lib\/.+|Gemfile|LICENSE|(?:CHANGELOG|README)\.adoc|\.yardopts|jekyll-asciidoc\.gemspec)$/
|
31
31
|
#s.test_files = files.grep %r/^spec\/./
|
32
32
|
|
33
33
|
s.require_paths = ['lib']
|
34
34
|
|
35
|
-
s.add_runtime_dependency 'asciidoctor', '>= 1.5.0'
|
35
|
+
s.add_runtime_dependency 'asciidoctor', ['>= 1.5.0', '< 3.0.0']
|
36
36
|
s.add_runtime_dependency 'jekyll', '>= 3.0.0'
|
37
37
|
|
38
|
-
s.add_development_dependency '
|
39
|
-
s.add_development_dependency 'pygments.rb', '~>
|
40
|
-
s.add_development_dependency 'rake', '~>
|
41
|
-
s.add_development_dependency 'rspec', '~> 3.
|
42
|
-
s.add_development_dependency 'rubocop', '~> 0.74.0'
|
43
|
-
s.add_development_dependency 'simplecov', '~> 0.17.0'
|
38
|
+
s.add_development_dependency 'kramdown-parser-gfm', '~> 1.1.0' # required when testing Jekyll 3
|
39
|
+
s.add_development_dependency 'pygments.rb', '~> 2.3.0'
|
40
|
+
s.add_development_dependency 'rake', '~> 13.1.0'
|
41
|
+
s.add_development_dependency 'rspec', '~> 3.12.0'
|
44
42
|
end
|
@@ -94,14 +94,15 @@ module Jekyll
|
|
94
94
|
'site-root' => ::Dir.pwd,
|
95
95
|
'site-source' => source,
|
96
96
|
'site-destination' => dest,
|
97
|
-
'site-baseurl' => config['baseurl'],
|
97
|
+
'site-baseurl' => (baseurl = config['baseurl']),
|
98
98
|
'site-url' => config['url'],
|
99
99
|
}
|
100
100
|
attrs = asciidoctor_config[:attributes] = compile_attributes asciidoctor_config[:attributes],
|
101
101
|
(compile_attributes asciidoc_config['attributes'],
|
102
102
|
((site_attributes.merge ImplicitAttributes).merge DefaultAttributes))
|
103
|
-
if (imagesdir = attrs['imagesdir']) &&
|
104
|
-
attrs['imagesoutdir'] = ::File.join dest, (imagesdir.chomp '@')
|
103
|
+
if (imagesdir = attrs['imagesdir']) && (imagesdir.start_with? '/')
|
104
|
+
attrs['imagesoutdir'] = ::File.join dest, (imagesdir.chomp '@') unless attrs.key? 'imagesoutdir'
|
105
|
+
attrs['imagesdir'] = baseurl + imagesdir unless baseurl.to_s.empty?
|
105
106
|
end
|
106
107
|
asciidoctor_config.extend Configured
|
107
108
|
end
|
@@ -217,6 +218,8 @@ module Jekyll
|
|
217
218
|
paths.delete 'docdir'
|
218
219
|
end
|
219
220
|
opts[:attributes] = opts[:attributes].merge paths
|
221
|
+
elsif opts[:base_dir] == :docdir
|
222
|
+
opts.delete :base_dir
|
220
223
|
end
|
221
224
|
if (doctype = data['doctype'])
|
222
225
|
opts[:doctype] = doctype
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jekyll-asciidoc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Dan Allen
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date:
|
12
|
+
date: 2023-11-06 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: asciidoctor
|
@@ -18,6 +18,9 @@ dependencies:
|
|
18
18
|
- - ">="
|
19
19
|
- !ruby/object:Gem::Version
|
20
20
|
version: 1.5.0
|
21
|
+
- - "<"
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: 3.0.0
|
21
24
|
type: :runtime
|
22
25
|
prerelease: false
|
23
26
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -25,6 +28,9 @@ dependencies:
|
|
25
28
|
- - ">="
|
26
29
|
- !ruby/object:Gem::Version
|
27
30
|
version: 1.5.0
|
31
|
+
- - "<"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 3.0.0
|
28
34
|
- !ruby/object:Gem::Dependency
|
29
35
|
name: jekyll
|
30
36
|
requirement: !ruby/object:Gem::Requirement
|
@@ -40,89 +46,61 @@ dependencies:
|
|
40
46
|
- !ruby/object:Gem::Version
|
41
47
|
version: 3.0.0
|
42
48
|
- !ruby/object:Gem::Dependency
|
43
|
-
name:
|
49
|
+
name: kramdown-parser-gfm
|
44
50
|
requirement: !ruby/object:Gem::Requirement
|
45
51
|
requirements:
|
46
52
|
- - "~>"
|
47
53
|
- !ruby/object:Gem::Version
|
48
|
-
version:
|
54
|
+
version: 1.1.0
|
49
55
|
type: :development
|
50
56
|
prerelease: false
|
51
57
|
version_requirements: !ruby/object:Gem::Requirement
|
52
58
|
requirements:
|
53
59
|
- - "~>"
|
54
60
|
- !ruby/object:Gem::Version
|
55
|
-
version:
|
61
|
+
version: 1.1.0
|
56
62
|
- !ruby/object:Gem::Dependency
|
57
63
|
name: pygments.rb
|
58
64
|
requirement: !ruby/object:Gem::Requirement
|
59
65
|
requirements:
|
60
66
|
- - "~>"
|
61
67
|
- !ruby/object:Gem::Version
|
62
|
-
version:
|
68
|
+
version: 2.3.0
|
63
69
|
type: :development
|
64
70
|
prerelease: false
|
65
71
|
version_requirements: !ruby/object:Gem::Requirement
|
66
72
|
requirements:
|
67
73
|
- - "~>"
|
68
74
|
- !ruby/object:Gem::Version
|
69
|
-
version:
|
75
|
+
version: 2.3.0
|
70
76
|
- !ruby/object:Gem::Dependency
|
71
77
|
name: rake
|
72
78
|
requirement: !ruby/object:Gem::Requirement
|
73
79
|
requirements:
|
74
80
|
- - "~>"
|
75
81
|
- !ruby/object:Gem::Version
|
76
|
-
version:
|
82
|
+
version: 13.1.0
|
77
83
|
type: :development
|
78
84
|
prerelease: false
|
79
85
|
version_requirements: !ruby/object:Gem::Requirement
|
80
86
|
requirements:
|
81
87
|
- - "~>"
|
82
88
|
- !ruby/object:Gem::Version
|
83
|
-
version:
|
89
|
+
version: 13.1.0
|
84
90
|
- !ruby/object:Gem::Dependency
|
85
91
|
name: rspec
|
86
92
|
requirement: !ruby/object:Gem::Requirement
|
87
93
|
requirements:
|
88
94
|
- - "~>"
|
89
95
|
- !ruby/object:Gem::Version
|
90
|
-
version: 3.
|
91
|
-
type: :development
|
92
|
-
prerelease: false
|
93
|
-
version_requirements: !ruby/object:Gem::Requirement
|
94
|
-
requirements:
|
95
|
-
- - "~>"
|
96
|
-
- !ruby/object:Gem::Version
|
97
|
-
version: 3.8.0
|
98
|
-
- !ruby/object:Gem::Dependency
|
99
|
-
name: rubocop
|
100
|
-
requirement: !ruby/object:Gem::Requirement
|
101
|
-
requirements:
|
102
|
-
- - "~>"
|
103
|
-
- !ruby/object:Gem::Version
|
104
|
-
version: 0.74.0
|
105
|
-
type: :development
|
106
|
-
prerelease: false
|
107
|
-
version_requirements: !ruby/object:Gem::Requirement
|
108
|
-
requirements:
|
109
|
-
- - "~>"
|
110
|
-
- !ruby/object:Gem::Version
|
111
|
-
version: 0.74.0
|
112
|
-
- !ruby/object:Gem::Dependency
|
113
|
-
name: simplecov
|
114
|
-
requirement: !ruby/object:Gem::Requirement
|
115
|
-
requirements:
|
116
|
-
- - "~>"
|
117
|
-
- !ruby/object:Gem::Version
|
118
|
-
version: 0.17.0
|
96
|
+
version: 3.12.0
|
119
97
|
type: :development
|
120
98
|
prerelease: false
|
121
99
|
version_requirements: !ruby/object:Gem::Requirement
|
122
100
|
requirements:
|
123
101
|
- - "~>"
|
124
102
|
- !ruby/object:Gem::Version
|
125
|
-
version:
|
103
|
+
version: 3.12.0
|
126
104
|
description: A Jekyll plugin that converts the AsciiDoc source files in your site
|
127
105
|
to HTML pages using Asciidoctor.
|
128
106
|
email:
|
@@ -134,7 +112,7 @@ files:
|
|
134
112
|
- ".yardopts"
|
135
113
|
- CHANGELOG.adoc
|
136
114
|
- Gemfile
|
137
|
-
- LICENSE
|
115
|
+
- LICENSE
|
138
116
|
- README.adoc
|
139
117
|
- jekyll-asciidoc.gemspec
|
140
118
|
- lib/jekyll-asciidoc.rb
|
@@ -174,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
174
152
|
- !ruby/object:Gem::Version
|
175
153
|
version: '0'
|
176
154
|
requirements: []
|
177
|
-
rubygems_version: 3.
|
155
|
+
rubygems_version: 3.1.6
|
178
156
|
signing_key:
|
179
157
|
specification_version: 4
|
180
158
|
summary: A Jekyll plugin that converts the AsciiDoc source files in your site to HTML
|