riven 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 831577b3a79f946e421a4710dfe66a73dd6b2afd
-  data.tar.gz: b4f642c8fc4bc5b83927798ef4603bb95e26108e
+  metadata.gz: b1fec2b7cfe9006f62d2698662b853c3316b0dad
+  data.tar.gz: de862e64da2cd58c5b3c5d6e6c84bff7a633cf06
 SHA512:
-  metadata.gz: b49782dbf7139d91c61e55996bf75eaa02df06c196ef22096606852d93f73f505774ecbddf05d66a91397f5a360ce278c2c5dd201fd3ee1001ffb0bc44a7a8a4
-  data.tar.gz: 6becb3aa12e1f2e1fd90d297a0f8536081cfeea329ee6d89668068cf25e476e5080ffdc10f358e46638075d7491849223d790f63fb3e5b3f531dd56d0ece1f13
+  metadata.gz: ac12bff4693139e89663306b4fce14eb6c3446c560abe2c7bd8503faed9bb5a9e3126729155ad7cc99334b0d744365126bf9f4a53ed963ca2c7ee74ebcdec2da
+  data.tar.gz: 7bae00360b4eb869b090e495b9583917ae74ea06c72c771aaa030cbe1f66a37f9b16c46850f5946dc3cf873a0a02c594b8815c68c18465a88e3b56d3e8c2b682

data/.gitignore

@@ -17,6 +17,7 @@ build/
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
+/doc/
 /rdoc/
 
 ## Environment normalisation:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    riven (1.1.1)
+    riven (1.1.2)
       coderay (~> 1.1)
       redcarpet (~> 3.2)
 

data/README.md

@@ -1,13 +1,12 @@
 # Riven
 
-Riven converts Markdown files to PDFs! Write documentations, books, reports and documents with your editor.
+Converts GitHub Flavored Markdown files to PDFs! Write documentations, books, reports and documents with your editor.
 Publish them as PDF! It's that simple and even more powerful.
 
 
 Feature highlights:
 
-- Riven Extended Markdown (it's GitHub Flavored Markdown but with more features!)
-- Includes: Structure you work!
+- Riven Extended Markdown featuring includes: Structure you work!
 - Generates well readable, optimized, beautiful looking PDFs
 - Style your PDF via CSS
 - Define a special and nice looking cover page
@@ -40,7 +39,7 @@ If it works, everything is nice and you may proceed with the next step. If not,
 correctly installed and the executable is within your `PATH`.
 
 
-## Getting started right now
+## Installation
 
 Simple as usual:
 
@@ -49,32 +48,20 @@ $ gem install riven
 ```
 
 
-## How to use it?
+## Usage
 
 Riven is designed to create documents out of a bunch of markdown files. So it may take a single markdown file or a
-directory with some markdown files inside.
-
-However the basic usage is very simple. This example will take your `example.md` and generate a `example.pdf` in the
-same directory:
-
-```bash
-$ riven example.md
-```
-
-Couldn't be easier!
-
-
-## Looking for an example?
-
-You'll find a considerable example of a markdown based documentation in the doc directory of riven itself. And **here**
-you finde the resulting PDF with the documentation of riven.
-
-
+directory with some markdown files inside. Consider that the files are merged in alphabetical order if you provide a
+folder. Just take a look at the following examples.
 
 
 ### Single file to PDF
 
+This will take your `example.md` and generate a `example.pdf` in the same directory:
 
+```bash
+$ riven example.md
+```
 
 
 ### Multiple files

data/lib/riven/markup_file.rb

@@ -57,11 +57,11 @@ module Riven
     #
 
     public def rewrite_paths
-      @markup.gsub!(/\[([^\]]+)\]\(([^\)]+)\)/) do |ref|
+      @markup.gsub!(/\[([^\]]+)\]\(([^\)]+)\)/) do |match|
         label = $1
         ref = $2
 
-        if $2 =~ /^http(s)?/
+        if ref =~ /^http(s)?/
           "[#{label}](#{ref})"
         else
           puts "    - Rewriting ref '#{ref}' to '#{@dirname}/#{ref}'"

data/lib/riven/opt_parser.rb

@@ -77,6 +77,7 @@ module Riven
           end
 
           opts.on('-V', '--version', 'Displays the version') do
+            require 'riven/version'
             puts Riven::VERSION.to_s
             exit
           end
@@ -88,4 +89,4 @@ module Riven
       end
     end
   end
-end
+end

data/lib/riven/version.rb

@@ -1,3 +1,3 @@
-class Riven
-  VERSION = '1.1.2'
+module Riven
+  VERSION = '1.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riven
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Benjamin Kammerl
@@ -81,14 +81,6 @@ files:
 - README.md
 - bin/riven
 - css/style.css
-- doc/chapters/1-what-is-riven/index.md
-- doc/chapters/2-setup/index.md
-- doc/chapters/3-basics/index.md
-- doc/chapters/4-advanced-usage/index.md
-- doc/cover.md
-- doc/img/cover.png
-- doc/index.md
-- doc/riven.pdf
 - lib/riven.rb
 - lib/riven/html_file.rb
 - lib/riven/html_generator.rb

data/doc/chapters/1-what-is-riven/index.md

@@ -1,15 +0,0 @@
-## 1. What is Riven?
-
-In one sentence: Riven is a command line tool, which converts a bunch of markdown files into a PDF file.
-
-**The question is: Why would you do that?**
-
-There are several scenarios where the usage off a tool like riven would make a lot of sense for you. Let's take a look
-at some of them:
-
-<<[ 1-scenario-a.md ]
-<<[ 2-scenario-b.md ]
-
-<<[ 3-what-is-riven-not.md ]
-<<[ 4-why-was-riven-created.md ]
-<<[ 5-how-can-i-support-riven.md ]

data/doc/cover.md

@@ -1,39 +0,0 @@
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-
-![riven](img/cover.png)
-
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-
-# Official Riven Manual
-## Write Markdown. Get a nice PDF. Have fun.
-
-
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-<br />
-
-
------
-
-powered by Benjamin Kammerl  |  visit *[github.com/phortx/riven](https://github.com/phortx/riven)*  |  MIT license

data/doc/index.md

@@ -1,4 +0,0 @@
-<<[ chapters/1-what-is-riven/index.md ]
-<<[ chapters/2-setup/index.md ]
-<<[ chapters/3-basics/index.md ]
-<<[ chapters/4-advanced-usage/index.md ]