riven 1.0.5 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49db77b6056da944f983b5eb47a5c80712d06c38
-  data.tar.gz: 6bf4f0531cf396c65d863260c86f8f4b937d1348
+  metadata.gz: 831577b3a79f946e421a4710dfe66a73dd6b2afd
+  data.tar.gz: b4f642c8fc4bc5b83927798ef4603bb95e26108e
 SHA512:
-  metadata.gz: 65acb17d1e06ab9bb28f1593eb2098e13bc25edf961e630dee0141fb61f657f12b74f968acfacf4239f0d4d8feacaf6823b55135f3c2153e47e2ba82b18d0763
-  data.tar.gz: e05c2d0a43166056203c068728be31222b723d8e0eba99b9d88e353c27e0d23f441f06adcc8afba7f107282f6f2c73de4c699806892833713547e994099b2172
+  metadata.gz: b49782dbf7139d91c61e55996bf75eaa02df06c196ef22096606852d93f73f505774ecbddf05d66a91397f5a360ce278c2c5dd201fd3ee1001ffb0bc44a7a8a4
+  data.tar.gz: 6becb3aa12e1f2e1fd90d297a0f8536081cfeea329ee6d89668068cf25e476e5080ffdc10f358e46638075d7491849223d790f63fb3e5b3f531dd56d0ece1f13

data/.gitignore

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

data/Gemfile.lock

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

data/README.md

@@ -1,38 +1,46 @@
 # Riven
 
-Converts GitHub Flavored Markdown files to PDFs! Feature highlights:
+Riven converts 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.
 
-- Highly readable PDFs with GitHub like theme
+
+Feature highlights:
+
+- Riven Extended Markdown (it's GitHub Flavored Markdown but with more features!)
+- Includes: Structure you work!
+- Generates well readable, optimized, beautiful looking PDFs
+- Style your PDF via CSS
+- Define a special and nice looking cover page
+- Auto generated table of contents
 - Syntax Highlighting with GitHub like theme
-- Smart page breaks
-- Smart directory based file merging
-- Smart output file naming
-- Page numbers (see *Prerequisites* section)
-- Custom CSS
-- Covers (see *Prerequisites* section)
-- Table of Contents (see *Prerequisites* section)
+- Page numbers
+- Smart directory based file merging and output file naming
 
 
 ## Prerequisites
 
-You need `wkhtmltopdf` in order to generate PDFs, since that's the PDF generator backend for riven. You should use the QT patched version of `wkhtmltopdf`. You may also use the version without patched qt, but that will disable the following features of riven: Page numbers, table of contents, covers.
+You need `wkhtmltopdf` in order to generate PDFs, since that's the PDF generator backend for riven. You should use the
+QT patched version of `wkhtmltopdf` to get all the features of riven. You may also use the version without patched qt,
+but that will disable the following features of riven: Page numbers, table of contents, covers.
 
 - If you got Arch Linux, you can just install the packages `wkhtmltopdf-static`and `icu48` from the AUR.
 
-- If you got another Linux Distribution (like Ubuntu) or OSX you have compile `wkhtmltopdf` from the sources. See http://natepinchot.com/2014/01/31/building-static-wkhtmltopdf/. This may take some time: On my i7, 16GB RAM, SSD Notebook it took about 20 minutes. 
+- If you got another Linux Distribution (like Ubuntu) or OSX you have compile `wkhtmltopdf` from the sources. See http://natepinchot.com/2014/01/31/building-static-wkhtmltopdf/. This may take some time: On my i7, 16GB RAM, SSD
+Notebook it took about 20 minutes.
 
 - Otherwise, you should download `wkhtmltopdf` from the [official website](http://wkhtmltopdf.org/downloads.html).
 
 After that, make sure you can execute the `wkhtmltopdf` command in your shell:
 
 ```bash
-$ wkhtmltopdf -v
+$ wkhtmltopdf -V
 ```
 
-If it works, everything is nice and you may proceed with the next step. If not, please make sure, `wkhtmltopdf` is correctly installed and the executable is within your `PATH`.
+If it works, everything is nice and you may proceed with the next step. If not, please make sure, `wkhtmltopdf` is
+correctly installed and the executable is within your `PATH`.
 
 
-## Installation
+## Getting started right now
 
 Simple as usual:
 
@@ -41,19 +49,33 @@ $ gem install riven
 ```
 
 
-## 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. Consider that the files are merged in alphabetical order if you provide a folder. Just take a look at the following examples.
-
+## How to use it?
 
-### Single file to PDF
+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.
 
-This will take your `example.md` and generate a `example.pdf` in the same directory:
+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.
+
+
+
+
+### Single file to PDF
+
+
+
 
 ### Multiple files
 
@@ -66,7 +88,9 @@ $ riven -o awesome.pdf example-1.md example-2.pdf
 
 ### A directory
 
-This will take your `documentation` directory with all it's files and generate a `documentation.pdf` (the name is guessed from the directory name, but you may also specify a output file name via the `-o` param) in the same directory:
+This will take your `documentation` directory with all it's files and generate a `documentation.pdf` (the name is
+guessed from the directory name, but you may also specify a output file name via the `-o` param) in the same
+directory:
 
 ```bash
 $ ls
@@ -87,6 +111,34 @@ documentation/
 ```
 
 
+### Structure via includes
+
+You may also structure your document via includes. Just define a main file and you may define as many include directives
+within that file and any other files (even in subdirectories) as you want.
+
+**index.md**
+
+```md
+## Just a example
+
+This is a include:
+
+<<[ another_file.md ]
+```
+
+**another_file.md**
+
+```md
+More **content** in this file.
+```
+
+Generate the PDF via:
+
+```bash
+$ riven -o awesome.pdf index.md
+```
+
+
 ## Additional Features
 
 ### Custom CSS

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

@@ -0,0 +1,15 @@
+## 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

@@ -0,0 +1,39 @@
+<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

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

data/lib/riven/markup_file.rb

@@ -1,10 +1,12 @@
+require 'pathname'
+
 module Riven
   #
   # Represents a MD File
   #
 
   class MarkupFile
-    attr_accessor :path
+    attr_reader :path, :dirname, :markup
 
 
     #
@@ -14,6 +16,7 @@ module Riven
 
     public def initialize(path)
       @path = File.expand_path(path)
+      @dirname = Pathname.new(path).dirname
 
       unless File.exists?(@path)
         raise "File '#{path}' doesn't exist"
@@ -22,6 +25,49 @@ module Riven
       if File.directory?(@path)
         raise "Mixing files and directories is not allowed, sorry"
       end
+
+      puts "Loading file: " + path
+      @markup = "\n" + File.read(@path)
+      rewrite_paths
+      resolve_includes
+    end
+
+
+    #
+    # Recursive replace all includes with their respective file content
+    #
+
+    public def resolve_includes
+      loop do
+        non_found = true
+
+        @markup.gsub!(/<<\[\s*([^\]\s]+)\s*\]/) do |inc|
+          non_found = false
+          MarkupFile.new(@dirname.to_s + '/' + $1).markup
+        end
+
+        break if non_found
+      end
+    end
+
+
+    #
+    # Prefixes all paths with the file basedir in order to make everything working across includes over different
+    # directories
+    #
+
+    public def rewrite_paths
+      @markup.gsub!(/\[([^\]]+)\]\(([^\)]+)\)/) do |ref|
+        label = $1
+        ref = $2
+
+        if $2 =~ /^http(s)?/
+          "[#{label}](#{ref})"
+        else
+          puts "    - Rewriting ref '#{ref}' to '#{@dirname}/#{ref}'"
+          "[#{label}](#{@dirname}/#{ref})"
+        end
+      end
     end
 
 
@@ -33,7 +79,9 @@ module Riven
         except = [except] unless except.respond_to?(:each)
 
         markup_files.each do |file|
-          markup << "\n\n" + File.read(file.path) unless exclude?(except, file)
+          unless exclude?(except, file)
+            markup << "\n" + file.markup
+          end
         end
 
         return markup
@@ -50,4 +98,4 @@ module Riven
       end
     end
   end
-end
+end

data/lib/riven/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riven
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.2
 platform: ruby
 authors:
 - Benjamin Kammerl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,14 @@ 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