jekyll-asciidoc 1.0.0.alpha.1 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.adoc +35 -17
- metadata +6 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 97faf9f23f10a720b2ac0b8110ccd556ce089a34
|
|
4
|
+
data.tar.gz: ebdeb3ce72ecb28138262ef94bd995f65e5b8e7e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6f498445e512a283e7b7599efe904e8a58713bb01b10c8441e345749d580818ba794fd7014d2a5e5cc889870d11a37238b49bc05cb309442e5aa6eff0288860f
|
|
7
|
+
data.tar.gz: b10dc4780ab898db1059665f79c3b433dcebd1b078967d16b51ae315c68613ac73fb84710d4df2b51e04f55c6d14c4ee24f0b73871426c31b6d931a0c9a9364d
|
data/README.adoc
CHANGED
|
@@ -21,39 +21,52 @@ You can install the gem using:
|
|
|
21
21
|
|
|
22
22
|
$ gem install asciidoctor
|
|
23
23
|
|
|
24
|
-
If you are using Bundler to manage the dependencies in your Jekyll project, then add the Asciidoctor gem
|
|
24
|
+
If you are using Bundler to manage the dependencies in your Jekyll project, then add the Asciidoctor gem to your `Gemfile` (below the Jekyll gem, named jekyll):
|
|
25
25
|
|
|
26
26
|
[source,ruby]
|
|
27
|
+
----
|
|
27
28
|
source 'https://rubygems.org'
|
|
29
|
+
|
|
28
30
|
gem 'jekyll'
|
|
29
31
|
gem 'asciidoctor'
|
|
32
|
+
----
|
|
30
33
|
|
|
31
|
-
Then, run the Bundler install command
|
|
32
|
-
|
|
33
|
-
$ bundle
|
|
34
|
-
|
|
35
|
-
=== Using a release
|
|
36
|
-
|
|
37
|
-
First, install the Jekyll AsciiDoc gem (named `jekyll-asciidoc`):
|
|
34
|
+
Then, run the Bundler install command
|
|
38
35
|
|
|
39
|
-
$
|
|
36
|
+
$ bundle install
|
|
40
37
|
|
|
41
|
-
|
|
38
|
+
=== Installing a released version of the plugin
|
|
42
39
|
|
|
40
|
+
Using Bundler::
|
|
41
|
+
+
|
|
42
|
+
Add `jekyll-asciidoc` plugin gem to your `Gemfile`
|
|
43
|
+
+
|
|
43
44
|
[source,ruby]
|
|
44
|
-
|
|
45
|
-
|
|
45
|
+
----
|
|
46
|
+
group :jekyll_plugins do
|
|
47
|
+
gem "jekyll-asciidoc"
|
|
48
|
+
end
|
|
49
|
+
----
|
|
50
|
+
+
|
|
46
51
|
Then, run the Bundler command to install it:
|
|
47
52
|
|
|
48
|
-
$ bundle
|
|
49
|
-
|
|
50
|
-
Finally, add the `jekyll-asciidoc` gem to the list of gems for Jekyll to load in your site's `_config.yml` file:
|
|
53
|
+
$ bundle install
|
|
51
54
|
|
|
55
|
+
Without Bundler::
|
|
56
|
+
+
|
|
57
|
+
If you are not using Bundler for managing Jekyll then install gems manually
|
|
58
|
+
+
|
|
59
|
+
$ gem install jekyll-asciidoc
|
|
60
|
+
+
|
|
61
|
+
And then, add `jekyll-asciidoc` gem to the list of gems for Jekyll to load in your site's `_config.yml` file:
|
|
62
|
+
+
|
|
52
63
|
[source,yaml]
|
|
64
|
+
----
|
|
53
65
|
gems:
|
|
54
66
|
- jekyll-asciidoc
|
|
67
|
+
----
|
|
55
68
|
|
|
56
|
-
===
|
|
69
|
+
=== Installing development version of the plugin
|
|
57
70
|
|
|
58
71
|
To install the development version of this plugin, copy `lib/asciidoc_plugin.rb` to the `_plugins` directory in the root of your site source.
|
|
59
72
|
|
|
@@ -81,7 +94,7 @@ puts "Hello, World!"
|
|
|
81
94
|
----
|
|
82
95
|
....
|
|
83
96
|
|
|
84
|
-
IMPORTANT: The AsciiDoc file must have a
|
|
97
|
+
IMPORTANT: The AsciiDoc file must have a http://jekyllrb.com/docs/frontmatter/[YAML front matter] header or else it won't be recognized as a page.
|
|
85
98
|
You can use an empty front matter header, as shown above, or you can define all your document metadata (e.g., document title) in the front matter instead of AsciiDoc attributes.
|
|
86
99
|
|
|
87
100
|
You can now build your site using:
|
|
@@ -91,6 +104,11 @@ You can now build your site using:
|
|
|
91
104
|
and preview it using:
|
|
92
105
|
|
|
93
106
|
$ jekyll serve
|
|
107
|
+
|
|
108
|
+
If you are using Bundler then use following commands to do the same
|
|
109
|
+
|
|
110
|
+
$ bundle exec jekyll build
|
|
111
|
+
$ bundle exec jekyll serve
|
|
94
112
|
|
|
95
113
|
IMPORTANT: If you use the `--safe` option, the AsciiDoc plugin will not be activated.
|
|
96
114
|
The `--safe` flag disables third-party plugins such as this one.
|
metadata
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-asciidoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.0
|
|
4
|
+
version: 1.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Dan Allen
|
|
8
|
+
- Paul Rayner
|
|
8
9
|
autorequire:
|
|
9
10
|
bindir: bin
|
|
10
11
|
cert_chain: []
|
|
11
|
-
date: 2015-01-
|
|
12
|
+
date: 2015-01-08 00:00:00.000000000 Z
|
|
12
13
|
dependencies:
|
|
13
14
|
- !ruby/object:Gem::Dependency
|
|
14
15
|
name: asciidoctor
|
|
@@ -42,6 +43,7 @@ description: A Jekyll plugin that converts AsciiDoc files in your site source to
|
|
|
42
43
|
pages using Asciidoctor.
|
|
43
44
|
email:
|
|
44
45
|
- dan.j.allen@gmail.com
|
|
46
|
+
- paul@virtual-genius.com
|
|
45
47
|
executables: []
|
|
46
48
|
extensions: []
|
|
47
49
|
extra_rdoc_files: []
|
|
@@ -65,9 +67,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
65
67
|
version: '0'
|
|
66
68
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
67
69
|
requirements:
|
|
68
|
-
- - "
|
|
70
|
+
- - ">="
|
|
69
71
|
- !ruby/object:Gem::Version
|
|
70
|
-
version:
|
|
72
|
+
version: '0'
|
|
71
73
|
requirements: []
|
|
72
74
|
rubyforge_project:
|
|
73
75
|
rubygems_version: 2.2.2
|