jekyll_aspec 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/{README.adoc → README.md} +9 -10
- data/lib/extensions/requirement_block_macro.rb +1 -1
- data/lib/jekyll_aspec.rb +2 -1
- data/lib/jekyll_aspec/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c39d61a6498f5af8f4d8ed4e5845a9f5ad0fac87
|
|
4
|
+
data.tar.gz: bdd6191dcd9382f9804ded987609672fb343b0ef
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b07a3e61eb8a373aea89fd6f526528dddd6875b671dfa8defd1cb9812f9ad7c4145be1bdd783ecc983e0d06ec9665cd6861bb5351c89556958776367d79fa5b7
|
|
7
|
+
data.tar.gz: ba7f2af116019673c1a3c9f2876ca047ba8039e4b8e9e660456bb6b8d2a5599d57323b4628b0e7c4cdf501b8cf859172c0782a2668ee38281519628ce6557509
|
data/Gemfile.lock
CHANGED
data/{README.adoc → README.md}
RENAMED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
|
|
1
|
+
# Jekyll Aspec
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://badge.fury.io/rb/jekyll_aspec) [](https://travis-ci.org/bsmith-n4/jekyll_aspec)
|
|
4
4
|
|
|
5
5
|
A selection of Asciidoctor extensions designed to used to write some AsciiSpec with Jekyll.
|
|
6
6
|
|
|
7
7
|
These extensions add custom blocks for Requirements and attempts to smartly handle inter-document auto-linking functionality.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
## Motivation
|
|
10
10
|
|
|
11
11
|
Jekyll is a very flexible and speedy tool for generating static HTML pages.
|
|
12
12
|
The `jekyl-asciidoc` gem adds Asciidoctor functionality but it lacks a few features due to the way it handles multiple source files. As each `.adoc` file is consumed individually, we lose the ability to automatically format inter-document cross-references. This plugin is a group of extensions that performs some directory walking, stores the location of titles and anchors so that cross references in a Jekyll project are resolved automatically.
|
|
@@ -23,7 +23,7 @@ Additional features are
|
|
|
23
23
|
|
|
24
24
|
When these custom extensions are combined with other recommended gems such as `asciidoctor-bibtex` and `asciidoctor-latex`, you can achieve quite high quality, speedy HTML documentation for technical projects with the benefits of a Jekyll build. It's recommended to use the `html-proofer` gem which will validate all links created with these extensions.
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
## Installation
|
|
27
27
|
|
|
28
28
|
Add `jekyll_aspec` to your Jekyll Gemfile:
|
|
29
29
|
|
|
@@ -38,17 +38,16 @@ Or install it yourself as:
|
|
|
38
38
|
|
|
39
39
|
$ gem install jekyll_aspec
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
## Docs
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
Yard documentation is generation automatically at http://www.rubydoc.info/gems/jekyll_aspec/
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
*<<docs/todo-block#,[TODO] - Todo Block>>*: Add a custom TODO admonition block. +
|
|
45
|
+
Also refer to the `docs` directory for some basic documentation on extended Asciidoctor features.
|
|
47
46
|
|
|
48
|
-
|
|
47
|
+
## Contributing
|
|
49
48
|
|
|
50
49
|
This gem is under heavy initial development and there are still many kinks to work out. The areas to be improved upon include performance enhancements, proper handling of file IO / directory walking and, of course, documentation. Bug reports and pull requests are welcome on GitHub at https://github.com/bsmith-n4/jekyll_aspec.
|
|
51
50
|
|
|
52
|
-
|
|
51
|
+
## License
|
|
53
52
|
|
|
54
53
|
The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].
|
data/lib/jekyll_aspec.rb
CHANGED
|
@@ -6,6 +6,7 @@ require_relative "extensions/inline_repo_macro"
|
|
|
6
6
|
require_relative "extensions/inline_task_macro"
|
|
7
7
|
require_relative "extensions/req_preprocessor"
|
|
8
8
|
require_relative "extensions/req_refs"
|
|
9
|
+
require_relative "extensions/requirement_block"
|
|
9
10
|
require_relative "extensions/requirement_block_macro"
|
|
10
11
|
require_relative "extensions/todo_block"
|
|
11
12
|
|
|
@@ -15,5 +16,5 @@ require "jekyll_aspec/version"
|
|
|
15
16
|
Extensions.register do
|
|
16
17
|
block TodoBlock
|
|
17
18
|
block RequirementBlock
|
|
18
|
-
block_macro
|
|
19
|
+
block_macro RequirementBlockMacro
|
|
19
20
|
end
|
data/lib/jekyll_aspec/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll_aspec
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- bsmith-n4
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2017-09-
|
|
11
|
+
date: 2017-09-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -82,7 +82,7 @@ files:
|
|
|
82
82
|
- Gemfile
|
|
83
83
|
- Gemfile.lock
|
|
84
84
|
- LICENSE.txt
|
|
85
|
-
- README.
|
|
85
|
+
- README.md
|
|
86
86
|
- Rakefile
|
|
87
87
|
- bin/console
|
|
88
88
|
- bin/setup
|