author 1.1.5.alpha → 1.1.6.alpha

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDE0ODkwNmFhODlhNDE2Njk1Mjc2Njk5NmZmMGM4ZTZjMjlkYWY3OA==
+    YjhjZGIwNmM5YWNhMzY0YmYwMjk3NjQ5MmM1NzZmZWQzNjVmNmIxZA==
   data.tar.gz: !binary |-
-    NTM4MzIyYTY5ZDI0ODk4ZWY5MmI0N2I3NDgzMTljZGM5Mjc2YWY2Yw==
+    NjgzYmIxNTYwYWFjODFjOGQxZWI4OThiOGNhYTE5MGE2YmZlMGIxNg==
 SHA512:
   metadata.gz: !binary |-
-    YmQ2MWY1OGQzMjczMmE0ODY0ZmI1YjFhNTVlNGZkYmE4NzUxODliZjk2Y2I4
-    MmYyMjIzMWFiMGFlNTA3YWIxMzgzZWVlNTk1ZWRhYTM3M2UzYzMxMjI3ZDhm
-    MTRiZjliZmUwNTRhZjk1YTBhZTIzN2Q3Y2YyNzdmMjAzZDRjNTY=
+    ZTdhNGYzYjcyMDlhM2QwNDBlOGFmNTFhZWM4YjRjNzViN2U1MTMwNzRkNjZi
+    YjIxN2QwOGRlNTNmYjhmNzk4ZmQ2MTM0MDExMWEwMmViNGYxMjQ5ODVlMGI0
+    NTQ2MzE3ZWIzMTc1NzEzZmVkMTEzNjc0MWRmNzQwMjIyZTg4YTM=
   data.tar.gz: !binary |-
-    YjAwODA1YzUxNGRmNjVhMzEzOTdiZGRkMjQzMzViMmRkNzQyMGUyMTgxZDA1
-    MmM0OGNhOWYyN2Y3MTgwOWMwMWNmODc5NTQyY2RkOTk5ZmFjZTQyM2U1ZWFh
-    Y2FhMDI3YWQ5Nzc3N2Q5ZTEzYzBjODYwY2E3MTc5MmVhYmM0MDk=
+    MWY3Y2YxMGU0YmM0MDgwMjc2YjQ1YTZmNzE0ZmJkN2FlMTc0OTQ3ZjY0MzFh
+    M2Q2MTMwODIyM2I3NDBlZDlkNjAwYTUwZGMxM2ZiNTViNTNhMDlkMWIzYzg5
+    NmEzNDczMGMxNGNkZWM3MWU2YzZmMWZhY2RmODA2NzdlNjAxNmQ=

data/README.md

@@ -24,33 +24,26 @@ Thus, Author was born.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'author'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself with:
-
     $ gem install author
 
-## Quick Start Guide
+## Usage  
 
     $ author new mybook
     $ cd mybook
 
 Add your chapters to the `chapters/` folder. Name them whatever you want. Then, in the
 `outline.txt` file, simply list the chapters in the order you want them to appear in the
-finished book:
+finished book. Here's an example of what `outline.txt` should look like:
 
     preface.md
     about-the-author.md
     who-is-this-for.md
     chapter-1.md
 
-Once you've done that, just run one of the following commands:
+In order to create ePubs, you will need to specify a few things. Open up `config.yml` and
+modify the settings that are listed.
+
+When you're ready to build your ebook, just run one of the following commands:
 
     author build xhtml
     author build pdf
@@ -60,9 +53,27 @@ Once you've done that, just run one of the following commands:
 
 That's it!
 
-## Full Tutorial
+## Extras
+
+One of the nice things about using Kramdown is that it provides a way to generate a table
+of contents [TOC]. If you would like to add a TOC to your book, simply add a file to the
+`chapters/` folder - might I suggest `toc.md` - and include the following:
+
+```
+## Table of Contents
+{:.no_toc}
+
+* this will be replaced
+{:toc}
+```
+
+Then, in the `outline.txt` file, just make sure the file with that information is
+the first one listed.
 
-Coming soon.
+For anyone wanting to write books that involve a lot of code, I have built a plugin
+called `awesome_codeblock`. You can specify quite a few options that will make your
+codeblocks, well, more awesome. Check out `lib/author/plugins/awesome_codeblock.rb`
+for all the details.
 
 ## Dependencies
 

data/TODO.md

@@ -0,0 +1,4 @@
+# TODO
+
+- Add the ability to include a cover image.
+- Add the ability to include images in the finished book formats.

data/lib/author/commands/builder.rb

@@ -34,6 +34,18 @@ module Author
         Author::Exporters::Epub.export
       end
       
+      desc "all", "Build everything"
+      def all
+        say "Building the XHTMl site"
+        Author::Exporters::XHTML.export
+        say "Building PDF"
+        Author::Exporters::PDF.export
+        say "Building the .mobi file"
+        Author::Exporters::Mobi.export
+        say "Building the epub file"
+        Author::Exporters::Epub.export
+      end
+      
     end
   end
 end

data/lib/author/plugins/awesome_codeblock.rb

@@ -22,21 +22,28 @@
 # You can set the language of the code block. The default is `:text` but you can specify
 # any of the code formats that CodeRay supports.
 #
-#  {% awesome_codeblock lang:"ruby" %}
+#  {% awesome_codeblock lang:ruby %}
 #  code goes here
 #  {% endawesome_codeblock %}
 #
 # You can choose to add line numbers as well. Refer to the documentation for
 # CodeRay::Encoder::HTML for values that can be passed in.
 #
-#  {% awesome_codeblock line_number_format:"inline" %}
+#  {% awesome_codeblock show_line_numbers:true %}
 #  code goes here
 #  {% endawesome_codeblock %}
 #
 # You can choose to highlight specific lines within your code block as well. Just supply
 # a comma separated list of line numbers.
 #
-#  {% awesome_codeblock lines_to_highlight:"2,3,4,7" %}
+#  {% awesome_codeblock highlight:"2,3,4,7" %}
+#  code goes here
+#  ...
+#  {% endawesome_codeblock %}
+#
+# If you want your line numbers to start at a specific number, you can do that too!
+#
+#  {% awesome_codeblock start_at:25 %}
 #  code goes here
 #  ...
 #  {% endawesome_codeblock %}
@@ -92,7 +99,7 @@ module Author
         wrapped_code = ''
         code.strip.split("\n").each_with_index do |line, index|
           index += starting_line_number
-          line = " " if line.empty?
+          line = line.empty? ? "&nbsp" : CodeRay.scan(line, language.to_sym).html
           lines        += %Q[<div class="line-number#{' highlight' if lines_to_highlight && lines_to_highlight.include?(index)}">#{index}</div>]
           wrapped_code += %Q[<div class="code-part#{' highlight' if lines_to_highlight && lines_to_highlight.include?(index)}">#{line}</div>]
         end

data/lib/author/version.rb

@@ -1,3 +1,3 @@
 module Author
-  VERSION = "1.1.5.alpha"
+  VERSION = "1.1.6.alpha"
 end

data/test/commands/builder_test.rb

@@ -22,4 +22,8 @@ describe Author::Commands::Builder do
     expect(output).to_include "epub"
   end
   
+  it "should respond to all" do
+    expect(output).to_include "all"
+  end
+  
 end

data/test/plugins/awesome_codeblock_test.rb

@@ -10,7 +10,7 @@ describe Author::Plugins::AwesomeCodeblock do
     it "should process the block into pretty code" do
       using_liquid_templates do
         rendered = liquid.parse(IO.read('no_options.md')).render
-        expect(rendered).to_include %q[puts "I'm awesome!"]
+        expect(rendered).to_include %q[puts "I'm awesome!"]
         expect(rendered).to_include %Q[<figure class="code text"><div class="CodeRay"><table class="code">]
         expect(rendered).to_not_include %q[<figcaption class='code-header'><span>]
         expect(rendered).to_not_include %q[<div class="line-number">]

data/test/sample_book/export/book.xhtml

@@ -8,7 +8,7 @@
     <div id="contents">
       <h2 id="this-is-chapter-one">This is chapter one</h2>
 
-<p>Liquid test </p>
+<p>Liquid test {{ foo }}</p>
 
 <h2 id="this-is-chapter-two">This is chapter two</h2>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: author
 version: !ruby/object:Gem::Version
-  version: 1.1.5.alpha
+  version: 1.1.6.alpha
 platform: ruby
 authors:
 - Terry Schmidt
@@ -192,6 +192,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - author.gemspec
 - bin/author
 - lib/author.rb