jekyll_asciidoctor_pdf 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4b11ffb4ac2be03a16972ded5242a70584fa5cd01c7d2b89be82dd723fa1805
-  data.tar.gz: b2f9ab8fb396f227940e2f3bae283f2ef7c5ffd3d88f389a32877594cadf67aa
+  metadata.gz: 81a66a88d2063060425ff0bd92f8a872ab0cd43c3adc91c83a3f9dfb30a01629
+  data.tar.gz: a0d82d2cb06efa99c9b3478b7f733dcea2740637c9ca83dd67ac6cdbb85d9cd1
 SHA512:
-  metadata.gz: 66de845ade0747136063df8d6021187ec0324df2749730b3f7c2afa9fdf2e6a36bb71f3a748766543b4ad9eceebb964b2a7ed3fa5a5813f5716521471716ba70
-  data.tar.gz: e273e68ad8847f1d4ac3f4b8264111595a41b65d2def3fdb7d5b0d3f46207ee0192ba58697cf698f76a4d129bee719bb6691690a3dce52a8525603ed5cff5a95
+  metadata.gz: a86d39357db19907c82a2268e8bc5dd287fafe1581e7037864964f5a0407ee48d2d442ae75586827ed39d2e973ca4de74baf2fddd55254386ea9f50320931206
+  data.tar.gz: 5aafdca752f5edb29c1495b50332a3b52480d55bb2cba9645aacf41ab6d098ae190fd15b6773824f0ef2b58f37d12236b951570798655cb324df523d2dec3cc7

data/.travis.yml

@@ -9,3 +9,4 @@ before_install:
 script:
 - bundle exec rake test
 - bundle exec rake build
+- bundle exec rake install

data/README.adoc

@@ -1,10 +1,98 @@
 = Jekyll PDF Generator using AsciiDoctor
-:gem-name: rake_jekyll_asciidoctor_pdf
+:gem-name: jekyll_asciidoctor_pdf
 :gh-branch: master
 :badge-style: flat
+:release-version: 0.0.14
 
 image:https://img.shields.io/gem/v/{gem-name}.svg?style={badge-style}[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+image:https://travis-ci.com/NetAppDocs/jekyll-asciidoctor-pdf.svg?token=jmKxRqiJdAgY6ceg7i2d&branch=master["Build Status", link="https://travis-ci.com/NetAppDocs/jekyll-asciidoctor-pdf"]
 
 toc::[]
 
+This gem allows you to generate PDFs from your Asciidoctor files.
+
+To simplify installation, JekyllAsciidoctorPDF is packaged and distributed as a RubyGem (aka gem) to https://rubygems.org/gems/{gem-name}[RubyGems.org].
+
+==  Bundler
+
+. Open your Gemfile in the root folder of your Jekyll project
+. Add the `{gem-name}` gem to your Gemfile as follows:
++
+[source,subs=attributes+]
+----
+source 'https://rubygems.org'
+gem '{gem-name}'
+
+# or specify the version explicitly
+# gem '{gem-name}', '{release-version}'
+----
+
+. Save the Gemfile
+. Open a terminal and install the gem using:
+
+ $ bundle
+
+
+== Rakefile
+
+. Open your Rakefile in the root folder of your Jekyll project
+. Add following lines 
+[source,Rakefile]
+----
+require 'rake_jekyll_asciidoctor_pdf'
+  
+RakeJekyllAsciidoctorPdf::BuildTask.new('buildAll') do |t|
+  t.jekyll_config_file = '_config.yml'
+end
+----
+
+. Save the Rakefile
+
+== Jekyll Configuration
+
+. Open your _config.yml in the root folder of your Jekyll project
+. Add following lines 
+[source,ruby]
+----
+jap_config:
+    sidebar_file: '_data/sidebar.yml'
+    output_path: 'pdfs'
+    source_path: '.'
+    assets_list: ['media']
+    exclude_list: []
+    fullsite:
+        title: "Main Title"
+        subtitle: "Subtitle"
+        authors: "Author1, Author2"
+        revision: "Revision Date"
+        background_image: 'cover_page_background.jpg'
+    pdf_theme:
+        extends: default
+----
+
+NOTE: This configuration assume an specific directory structure 
+
+== Directory Structure
+
+A basic directory structure usually looks something like this:
+
+```
+.
+├── _config.yml
+├── _data
+│   └── sidebar.yml
+├── media 
+│   └── assets files 
+├── pdfs # this folder will be created by rake_jekyll_asciidoctor_pdf
+│   ├── pages/
+│   └── fullsite/
+└── *.adoc # all asciidoc files are in the root level 
+```
+
+
+== Usage
+
+ $ bundle exec rake buildAll
+
+
 

data/jekyll_asciidoctor_pdf.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Rake tasks to convert *.adoc files from Jekyll to PDF using asciidoctor-pdf'
   spec.description   = 'Rake tasks to convert *.adoc files from Jekyll to PDF using asciidoctor-pdf'
-  spec.homepage      = 'https://github.com/ggenzone/jekyll_asciidoctor_pdf'
+  spec.homepage      = 'https://rubygems.org/gems/jekyll_asciidoctor_pdf'
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

data/lib/jekyll_asciidoctor_pdf/commands.rb

@@ -275,6 +275,12 @@ module JekyllAsciidoctorPdf
                 cp_r(file, absolute_temp_path, quiet)
             end
 
+            fullsite_config  = parameters['fullsite']
+            background_image        = File.join(absolute_working_path, fullsite_config['background_image'])
+            output_background_image = File.join(absolute_temp_path, '/media', 'cover_page_background.jpg')
+            cp_r(background_image, output_background_image, quiet)  
+
+
             output = File.join(absolute_output_path,'fullsite_template.pdf')
             #cp(File.join('fullsite_template.adoc'),build_fullsite_output , quiet)
             cd(absolute_temp_path)
@@ -308,7 +314,7 @@ module JekyllAsciidoctorPdf
             subtitle = fullsite_config['subtitle']
             authors  = fullsite_config['authors']
             revision = fullsite_config['revision']
-            background_image = fullsite_config['background_image']
+            #background_image = fullsite_config['background_image']
 
             text = <<~TEXT
                 = #{title} : #{subtitle}
@@ -329,7 +335,7 @@ module JekyllAsciidoctorPdf
                 ifdef::backend-pdf[]
                 :pdf-theme: pdf-theme.yml 
                 :title-page:
-                :title-page-background-image: image:#{background_image}[fit=none,pdfwidth=100%,position=top]
+                :title-page-background-image: image:cover_page_background.jpg[fit=none,pdfwidth=100%,position=top]
                 :source-highlighter: rouge
                 //:rouge-style: github
                 endif::[]

data/lib/jekyll_asciidoctor_pdf/version.rb

@@ -1,3 +1,3 @@
 module JekyllAsciidoctorPdf
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_asciidoctor_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Guido Genzone
@@ -127,7 +127,7 @@ files:
 - lib/jekyll_asciidoctor_pdf/commands.rb
 - lib/jekyll_asciidoctor_pdf/tree.rb
 - lib/jekyll_asciidoctor_pdf/version.rb
-homepage: https://github.com/ggenzone/jekyll_asciidoctor_pdf
+homepage: https://rubygems.org/gems/jekyll_asciidoctor_pdf
 licenses:
 - MIT
 metadata: {}