paperwork 0.2.0 → 0.2.5
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/Gemfile.lock +1 -1
- data/Rakefile +1 -1
- data/lib/paperwork/tasks.rb +1 -1
- data/lib/paperwork/tasks/document.rb +11 -4
- data/lib/paperwork/tasks/middleman_template/config.rb +0 -1
- data/lib/paperwork/tasks/middleman_template/lib/doc_renderer.rb +9 -6
- data/lib/paperwork/tasks/middleman_template/lib/info_helpers.rb +21 -1
- data/lib/paperwork/tasks/root_helpers.rb +1 -1
- data/lib/paperwork/version.rb +1 -1
- data/{navdemo.md → nested_example/navdemo.md} +3 -0
- data/site.yml +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1955714ea9b28ec4ec30953e9bb6d9fdde843dc6b07b1e845250272e06d231ce
|
4
|
+
data.tar.gz: f173804ede9bd1280bd724867b34aac75cae1d48e9ef13735e0ca5957185dcf3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2a5f3811fbbe9c7f8a48e120f83e4dad99a5e48ea15489d183a64d627f1ecdf210734e08f764c559298df7f832affc1e232e17f65cded172f59d9111a4ffc90f
|
7
|
+
data.tar.gz: 0fbb45795dcfa953c0e9479e0a8c135e799a6fbb41f26cd59471d7e0a5a6fb083832bb6082d8881fc2f1368e302425209b7d6170b4ee98c537825f37cd28326f
|
data/Gemfile.lock
CHANGED
data/Rakefile
CHANGED
@@ -13,4 +13,4 @@ task rebuild: [:clean, :build]
|
|
13
13
|
task default: :spec
|
14
14
|
CLEAN.include(".work/coverage")
|
15
15
|
|
16
|
-
paperwork :doc, sources: ["README.md", "navdemo.md", "site.yml", "custom.js", "custom.css"]
|
16
|
+
paperwork :doc, sources: ["README.md", "nested_example/navdemo.md", "site.yml", "custom.js", "custom.css"]
|
data/lib/paperwork/tasks.rb
CHANGED
@@ -17,7 +17,7 @@ module Paperwork
|
|
17
17
|
dependencies = []
|
18
18
|
if task.nil?
|
19
19
|
task = options.keys.first
|
20
|
-
dependencies = options.delete(
|
20
|
+
dependencies = options.delete(task)
|
21
21
|
end
|
22
22
|
doc = Paperwork::Tasks::Document.new(task, sources, *dependencies)
|
23
23
|
doc.create_tasks
|
@@ -35,18 +35,25 @@ module Paperwork
|
|
35
35
|
private
|
36
36
|
|
37
37
|
def get_destination(dst_base, src) # rubocop:disable Metrics/AbcSize
|
38
|
+
nested_base = File.dirname(src)
|
39
|
+
if nested_base == "."
|
40
|
+
nested_base = dst_base
|
41
|
+
else
|
42
|
+
nested_base = File.join(dst_base, nested_base)
|
43
|
+
end
|
44
|
+
|
38
45
|
ext = File.extname(src)
|
39
46
|
case ext
|
40
47
|
when ".md"
|
41
|
-
File.join(
|
48
|
+
File.join(nested_base, File.basename(src)).gsub(".md", ".html.md")
|
42
49
|
when ".scss"
|
43
|
-
Paperwork::Config[:custom_css] << File.basename(src)
|
50
|
+
Paperwork::Config[:custom_css] << File.basename(src, ext)
|
44
51
|
File.join(dst_base, "stylesheets", File.basename(src)).gsub(".scss", ".css.scss")
|
45
52
|
when ".css"
|
46
|
-
Paperwork::Config[:custom_css] << File.basename(src)
|
53
|
+
Paperwork::Config[:custom_css] << File.basename(src, ext)
|
47
54
|
File.join(dst_base, "stylesheets", File.basename(src))
|
48
55
|
when ".js"
|
49
|
-
Paperwork::Config[:custom_js] << File.basename(src)
|
56
|
+
Paperwork::Config[:custom_js] << File.basename(src, ext)
|
50
57
|
File.join(dst_base, "javascripts", File.basename(src))
|
51
58
|
when ".yml"
|
52
59
|
File.join(dst_base, "..", "data", File.basename(src))
|
@@ -6,10 +6,12 @@
|
|
6
6
|
#
|
7
7
|
module DocRenderer
|
8
8
|
require "middleman-core/renderers/redcarpet"
|
9
|
+
require_relative "info_helpers"
|
9
10
|
|
10
11
|
# This is a basic renderer for transforming markdown to HTML
|
11
12
|
# inherit from this renderer to create more specific variants
|
12
13
|
class Base < Middleman::Renderers::MiddlemanRedcarpetHTML
|
14
|
+
include InfoHelpers
|
13
15
|
|
14
16
|
# block level calls
|
15
17
|
def block_code(code, language)
|
@@ -79,11 +81,12 @@ module DocRenderer
|
|
79
81
|
# def emphasis(text)
|
80
82
|
# end
|
81
83
|
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
84
|
+
def image(link, title, alt_text)
|
85
|
+
<<~IMG
|
86
|
+
<img src="#{relative_link link, scope.current_path}" alt="#{alt_text}" class="img-fluid">#{title}</img>
|
87
|
+
IMG
|
88
|
+
#super(relative_link(link, scope.current_path), title, alt_text)
|
89
|
+
end
|
87
90
|
|
88
91
|
# def linebreak()
|
89
92
|
# end
|
@@ -119,7 +122,7 @@ module DocRenderer
|
|
119
122
|
private
|
120
123
|
|
121
124
|
def definition_list(text)
|
122
|
-
str =
|
125
|
+
str = String.new
|
123
126
|
re = /^[^:].*?(?:\R: .*)+/
|
124
127
|
text.scan(re) do |match|
|
125
128
|
list = match.split(":")
|
@@ -20,6 +20,21 @@ module InfoHelpers
|
|
20
20
|
end
|
21
21
|
end
|
22
22
|
|
23
|
+
def relative_link(stringifyable, current_path=current_page.path)
|
24
|
+
relative = String.new
|
25
|
+
dots = current_path.split(/[\/\\]/).size - 1
|
26
|
+
dots.times{ relative += "../" }
|
27
|
+
# This has been some nasty part to debug...
|
28
|
+
# keep these comments for debugging session yet to come
|
29
|
+
# puts "##################################"
|
30
|
+
# puts "current_page.path: #{current_page.path}"
|
31
|
+
# puts "stringifyable: #{stringifyable.to_s}"
|
32
|
+
# puts "dots: #{dots}"
|
33
|
+
# puts "relative link: #{relative + stringifyable.to_s}"
|
34
|
+
# puts "##################################"
|
35
|
+
relative + stringifyable.to_s
|
36
|
+
end
|
37
|
+
|
23
38
|
def site?
|
24
39
|
data.respond_to?(:site)
|
25
40
|
end
|
@@ -30,7 +45,12 @@ module InfoHelpers
|
|
30
45
|
|
31
46
|
def navbar_links
|
32
47
|
nav = data.site.navbar.links if navbar?
|
33
|
-
nav
|
48
|
+
nav ||= {}
|
49
|
+
mapped = {}
|
50
|
+
nav.each do |name, link|
|
51
|
+
mapped[name] = relative_link(link)
|
52
|
+
end
|
53
|
+
mapped
|
34
54
|
end
|
35
55
|
|
36
56
|
def navbar_brand
|
data/lib/paperwork/version.rb
CHANGED
data/site.yml
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: paperwork
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.2.
|
4
|
+
version: 0.2.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Tobias Schmid
|
@@ -161,7 +161,7 @@ files:
|
|
161
161
|
- lib/paperwork/tasks/root_helpers.rb
|
162
162
|
- lib/paperwork/tasks/template.rb
|
163
163
|
- lib/paperwork/version.rb
|
164
|
-
- navdemo.md
|
164
|
+
- nested_example/navdemo.md
|
165
165
|
- paperwork.gemspec
|
166
166
|
- site.yml
|
167
167
|
homepage: https://gitlab.com/couchbelag/paperwork
|