kitabu 2.1.0 → 3.0.0

data/templates/templates/styles/{pdf.scss → pdf.css}

@@ -1,10 +1,12 @@
-@import './files/normalize';
+@import "./files/normalize.css";
 
-$frontcover-color: #5091b1;
-$page-height: 22.86cm;
-$page-height: 19.05cm;
-
-$frontcover-padding: 50px;
+:root {
+  --frontcover-color: #5091b1;
+  --frontcover-darker-color: #40748e;
+  --frontcover-padding: 50px;
+  --page-height: 22.86cm;
+  --page-height: 19.05cm;
+}
 
 @page {
   size: 19.05cm 22.86cm portrait;
@@ -36,8 +38,8 @@ $frontcover-padding: 50px;
 
 @page frontcover {
   margin: 0;
-  background: $frontcover-color;
-  border-left: 50px solid darken($frontcover-color, 10%);
+  background: var(--frontcover-color);
+  border-left: 50px solid var(--frontcover-darker-color);
 }
 
 @page chapter {
@@ -47,7 +49,7 @@ $frontcover-padding: 50px;
   @footnotes {
     border-top: thin solid #777;
     margin-top: 1em;
-    padding-top: .5em;
+    padding-top: 0.5em;
   }
 }
 
@@ -69,14 +71,14 @@ body {
 }
 
 a {
-  color: $frontcover-color;
+  color: var(--frontcover-color);
 }
 
 .go-top {
   display: none;
 }
 
-// White page
+/* White page */
 .white-page {
   page: white;
   page-break-before: always;
@@ -84,7 +86,7 @@ a {
 }
 
 .white-page:before {
-  content: 'This page intentionally left blank';
+  content: "This page intentionally left blank";
   text-transform: uppercase;
   position: absolute;
   left: 0;
@@ -94,10 +96,10 @@ a {
   transform: translatey(-50%);
 }
 
-// Style frontcover
+/* Style frontcover */
 .frontcover {
   page: frontcover;
-  padding: $frontcover-padding;
+  padding: var(--frontcover-padding);
   padding-left: 0;
   text-align: center;
   font-family: sans-serif;
@@ -108,7 +110,7 @@ a {
 }
 
 .frontcover .logo {
-  background: url('../images/kitabu-word.svg') no-repeat center bottom;
+  background: url("../images/kitabu-word.svg") no-repeat center bottom;
   height: 150px;
   margin-bottom: 35px;
 }
@@ -121,13 +123,13 @@ a {
   display: inline-block;
   width: 400px;
   font-size: 20px;
-  color: rgba(#fff, .7);
+  color: rgba(#fff, 0.7);
 }
 
 .frontcover .description:after {
-  content: '';
+  content: "";
   display: block;
-  background: url('../images/kitabu-icon.svg') no-repeat center bottom;
+  background: url("../images/kitabu-icon.svg") no-repeat center bottom;
   background-size: 200px;
   height: 300px;
   margin-top: 50px;
@@ -135,18 +137,18 @@ a {
 
 .frontcover .authors {
   font-size: 24px;
-  padding: $frontcover-padding;
+  padding: var(--frontcover-padding);
   font-weight: bold;
   margin-top: 30px;
-  color: rgba(#000, .4);
+  color: rgba(#000, 0.4);
   text-transform: uppercase;
 }
 
 .frontcover .authors:before {
-  content: 'By ';
+  content: "By ";
 }
 
-// Style chapter
+/* Style chapter */
 .chapters {
   counter-reset: chapter;
 }
@@ -160,9 +162,9 @@ a {
 .chapter > h2 {
   font-family: sans-serif;
   margin: -100px -100px 75px -100px;
-  background: $frontcover-color;
+  background: var(--frontcover-color);
   padding: 100px;
-  color: rgba(#fff, .6);
+  color: rgba(#fff, 0.6);
   font-size: 40px;
 }
 
@@ -171,14 +173,14 @@ a {
 }
 
 .chapter > h2:before {
-  content: 'Chapter ' counter(chapter);
+  content: "Chapter " counter(chapter);
   display: block;
   font-size: 18px;
   text-transform: uppercase;
   color: #fff;
 }
 
-// Code highlighting
+/* Code highlighting */
 p code,
 li code {
   font-size: 12px;
@@ -199,7 +201,7 @@ li code {
   padding-right: 15px;
 }
 
-// Format lexers list
+/* Format lexers list */
 .lexers-list {
   margin: 0;
   padding: 0;
@@ -220,7 +222,7 @@ li code {
   margin-top: 15px;
 }
 
-// Table of contents
+/* Table of contents */
 .table-of-contents {
   page: chapter;
   font-family: sans-serif;
@@ -229,9 +231,9 @@ li code {
 .table-of-contents > h2 {
   font-family: sans-serif;
   margin: -100px -100px 75px -100px;
-  background: $frontcover-color;
+  background: var(--frontcover-color);
   padding: 100px;
-  color: rgba(#fff, .6);
+  color: rgba(#fff, 0.6);
   font-size: 40px;
 }
 
@@ -239,10 +241,10 @@ li code {
   text-decoration: none;
 }
 
-.table-of-contents {
-  .level4 { display: none; }
-  .level5 { display: none; }
-  .level6 { display: none; }
+.table-of-contents .level4,
+.table-of-contents .level5,
+.table-of-contents .level6 {
+  display: none;
 }
 
 .table-of-contents * + .level2 {
@@ -256,13 +258,13 @@ li code {
   font-size: 20px;
   position: relative;
   padding-left: 25px;
+}
 
-  &:before {
-    content: target-counter(attr(href), page) " ";
-    position: absolute;
-    left: 0;
-    transform: translatex(-100%);
-  }
+.table-of-contents .level2 a:before {
+  content: target-counter(attr(href), page) " ";
+  position: absolute;
+  left: 0;
+  transform: translatex(-100%);
 }
 
 .table-of-contents .level3 {
@@ -276,21 +278,21 @@ li code {
 .table-of-contents .level3 a {
   position: relative;
   color: #777;
+}
 
-  &:after {
-    content: leader('.') target-counter(attr(href), page) " ";
-    cursor: default;
-  }
+.table-of-contents .level3 a:after {
+  content: leader(".") target-counter(attr(href), page) " ";
+  cursor: default;
 }
 
-// Footnotes
+/* Footnotes */
 .footnote {
   display: prince-footnote;
   footnote-style-position: inside;
   position: footnote;
 }
 
-// Notes
+/* Notes */
 .note {
   font-size: 13px;
   float: right;
@@ -301,7 +303,7 @@ li code {
 }
 
 .note:before {
-  content: '!';
+  content: "!";
   display: inline-block;
   font-size: 25px;
   width: 10px;

data/templates/templates/styles/print.css

@@ -0,0 +1,2 @@
+@import "./files/normalize.css";
+@import "./pdf.css";

data/templates/text/01_Getting_Started.md

@@ -1,26 +1,44 @@
 ## Getting Started
 
-This guide is designed for beginners who want to get started with Kitabu from scratch. However, to get the most out of it, you need to have some prerequisites installed:
+This guide is designed for beginners who want to get started with Kitabu from
+scratch. However, to get the most out of it, you need to have some prerequisites
+installed:
 
-* The [Ruby](http://ruby-lang.org) interpreter version 2.0.0 or greater.
-* The [PrinceXML](http://princexml.com) converter version 9.0 or greater.
-* The [KindleGen](http://www.amazon.com/gp/feature.html?docId=1000765211) converter.
+- The [Ruby](http://ruby-lang.org) interpreter version 2.0.0 or greater.
+- The [PrinceXML](http://princexml.com) converter version 9.0 or greater.
+- The [KindleGen](http://www.amazon.com/gp/feature.html?docId=1000765211)
+  converter.
 
 ### Installing Ruby
 
-To install Ruby, consider using [RVM](http://rvm.io) or [rbenv](http://rbenv.org), both available for Mac OSX and Linux distros. If you're running a Windows, well, I can't help you. I don't even know if Kitabu runs over Windows boxes, so if you find any bugs, make sure you [let me know](http://github.com/fnando/kitabu/issues).
+To install Ruby, consider using [RVM](http://rvm.io) or
+[rbenv](http://rbenv.org), both available for Mac OSX and Linux distros. If
+you're running a Windows, well, I can't help you. I don't even know if Kitabu
+runs over Windows boxes, so if you find any bugs, make sure you
+[let me know](http://github.com/fnando/kitabu/issues).
 
 ### Installing PrinceXML
 
-[PrinceXML](http://princexml.com) is the best HTML to PDF converter available. You can use advanced CSS features to style your book in any way you want. But good things don't come for free, and PrinceXML is no exception. The Professional License, which you grant you a installation on a single computer by a single user costs 495USD. If you don't like the price tag, consider using [DocRaptor](http://docraptor.com) when you're ready to publish your book.
+[PrinceXML](http://princexml.com) is the best HTML to PDF converter available.
+You can use advanced CSS features to style your book in any way you want. But
+good things don't come for free, and PrinceXML is no exception. The Professional
+License, which you grant you a installation on a single computer by a single
+user costs 495USD. If you don't like the price tag, consider using
+[DocRaptor](http://docraptor.com) when you're ready to publish your book.
 
-To install PrinceXML, go to the website and download the correct version for your platform; you can choose from Mac OSX, to Linux and Windows.
+To install PrinceXML, go to the website and download the correct version for
+your platform; you can choose from Mac OSX, to Linux and Windows.
 
 ### Installing KindleGen
 
-KindleGen is the command-line tool that allows you to convert e-pubs into `.mobi` files. You can't sell these files, though.[^1] So if that's the case, consider using [Calibre](http://calibre-ebook.com/) for this task.[^2]
+KindleGen is the command-line tool that allows you to convert e-pubs into
+`.mobi` files. You can't sell these files, though.[^1] So if that's the case,
+consider using [Calibre](http://calibre-ebook.com/) for this task.[^2]
 
-If you're running [Homebrew](http://brew.sh) on the Mac OSX, you can install it with `brew install kindlegen`. Go to [KindleGen's website](http://www.amazon.com/gp/feature.html?docId=1000765211) and download the appropriate installer otherwise.
+If you're running [Homebrew](http://brew.sh) on the Mac OSX, you can install it
+with `brew install kindlegen`. Go to
+[KindleGen's website](http://www.amazon.com/gp/feature.html?docId=1000765211)
+and download the appropriate installer otherwise.
 
 [^1]: You can, but that would be a violation of Amazon's terms of use.
 [^2]: Calibre is not perfect, but does a good job.

data/templates/text/02_Creating_Chapters.md

@@ -1,8 +1,13 @@
 ## Creating Chapters
 
-You can create chapters by having multiple files or directories. They're alphabetically sorted, so make sure you use a prefixed file name like  `01_Introduction.md` as the file name.
+You can create chapters by having multiple files or directories. They're
+alphabetically sorted, so make sure you use a prefixed file name like
+`01_Introduction.md` as the file name.
 
-If you're going to write a long book, make sure you use the directory organization. This way you can have smaller text files, which will be easier to read and change as you go. A file structure suggestion for a book about [Ruby on Rails](http://guides.rubyonrails.com) would be:
+If you're going to write a long book, make sure you use the directory
+organization. This way you can have smaller text files, which will be easier to
+read and change as you go. A file structure suggestion for a book about
+[Ruby on Rails](http://guides.rubyonrails.com) would be:
 
 ```text
 getting-started-with-rails
@@ -19,4 +24,5 @@ getting-started-with-rails
     └── ...
 ```
 
-Notice that the file name does not need to be readable, but it will make your life easier.
+Notice that the file name does not need to be readable, but it will make your
+life easier.

data/templates/text/{03_Syntax_Highlighting.erb → 03_Syntax_Highlighting.md.erb}

@@ -2,9 +2,12 @@
 
 ### What about the syntax
 
-Kitabu uses [Route](http://rubygems.org/gems/rouge) as the syntax highlight formatter. It emits an output compatible with stylesheets designed for [pygments](https://pygments.org), the Python library used by many.
+Kitabu uses [Route](http://rubygems.org/gems/rouge) as the syntax highlight
+formatter. It emits an output compatible with stylesheets designed for
+[pygments](https://pygments.org), the Python library used by many.
 
-To highlight a code block, use the fenced block syntax. The following example would be formatted as Ruby.
+To highlight a code block, use the fenced block syntax. The following example
+would be formatted as Ruby.
 
     ```ruby
     class User
@@ -30,9 +33,9 @@ class User
 end
 ```
 
-<% note do %>
-  If you're using Sublime Text, make sure you install the [Markdown Extended](https://packagecontrol.io/packages/Markdown%20Extended) plugin; it enables code syntax highlighting on your Markdown files.
-<% end %>
+<% note do %> If you're using Sublime Text, make sure you install the
+[Markdown Extended](https://packagecontrol.io/packages/Markdown%20Extended)
+plugin; it enables code syntax highlighting on your Markdown files. <% end %>
 
 You can also provide inline options such as line numbers and inline rendering.
 
@@ -62,8 +65,10 @@ end
 
 ### Lexers
 
-Rouge comes with dozens of lexers. Check out this list, generated dynamically when you export your e-book.
+Rouge comes with dozens of lexers. Check out this list, generated dynamically
+when you export your e-book.
 
 <%= lexers_list %>
 
-And if what you want is not on this list, make you [open a ticket](https://github.com/jneen/rouge/issues) on the project.
+And if what you want is not on this list, make you
+[open a ticket](https://github.com/jneen/rouge/issues) on the project.

data/templates/text/04_Dynamic_Content.md.erb

@@ -0,0 +1,48 @@
+## Dynamic Content
+
+Sometimes you may find useful to generate content dynamically. Maybe you're
+going to read some configuration file, or maybe you just want to define some
+helpers. Kitabu has support for ERb files; all you need to do is naming your
+text file as `.md.erb`.
+
+On the previous chapter, we listed all supported Rouge lexers. To do that, I
+created a helper that looks like this:
+
+```ruby
+<%= File.read("./config/helper.rb") %>
+```
+
+To use it, I just needed to add `<%%= lexers_list %>` to my text file. This
+allows you to create anything you need!
+
+Kitabu comes with some built-in helpers, such as `note`. With this helper, you
+can create a note that generates a HTML structure, so you can easily style it.
+The syntax for using the `note` helper is `note(type, &block)`.
+
+```erb
+<%% note do %>
+  Some text that will be parsed as Markdown.
+<%% end %>
+```
+
+By default, this will generate a `<div class="note info">` tag, but you can use
+anything you want.
+
+```erb
+<%% note :warning do %>
+  Some text that will be parsed as Markdown.
+<%% end %>
+```
+
+[Check out the source](https://github.com/fnando/kitabu/blob/cleanup/lib/kitabu/helpers.rb)
+for a sample on how to create block helpers like `note`.
+
+### Escaping ERb code
+
+If you want to write a book about Rails, you're likely to use lots of ERb tags.
+In this case, make sure you escape the `<%% %>` and `<%%= %>` markers as
+`<%%% %>` and `<%%%= %>`; otherwise you'll have a syntax error.
+
+```
+<%%%= Date.today %>
+```

data/templates/text/05_Exporting_Files.md

@@ -1,13 +1,16 @@
 ## Exporting Files
 
-You can generate files as you go. Just execute `kitabu export` from your book's root directory.
+You can generate files as you go. Just execute `kitabu export` from your book's
+root directory.
 
 ```
 $ kitabu export
 ** e-book has been exported
 ```
 
-This command will generate all supported formats[^1]. The generated files will be placed on your `output` directory; the following output list only the relevant files.
+This command will generate all supported formats[^1]. The generated files will
+be placed on your `output` directory; the following output list only the
+relevant files.
 
 ```
 $ tree output
@@ -20,7 +23,6 @@ output
 ├── kitabu.mobi
 ├── kitabu.pdf
 ├── kitabu.print.pdf
-├── kitabu.txt
 └── styles
     ├── epub.css
     ├── html.css
@@ -28,22 +30,29 @@ output
     └── print.css
 ```
 
-This can take a while depending on your book size, but usually the process is pretty fast. If you want to generate a specific format faster, provide the `--only` flag.
+This can take a while depending on your book size, but usually the process is
+pretty fast. If you want to generate a specific format faster, provide the
+`--only` flag.
 
 ```
 $ kitabu export --only pdf
 ```
 
-You can also automatically generate files when something changes. You can use [Guard](http://rubygems.org/gems/guard) for this, and Kitabu even generates a sample file for you. All you have to do is running `bundle exec guard`.
+You can also automatically generate files when something changes. You can use
+[Guard](http://rubygems.org/gems/guard) for this, and Kitabu even generates a
+sample file for you. All you have to do is running `bundle exec guard`.
 
 ```
 $ bundle exec guard
-20:38:10 - INFO - Guard is now watching at '/Users/fnando/Projects/kitabu/examples/kitabu'
+20:38:10 - INFO - Guard is now watching at 'kitabu/examples/kitabu'
 ** e-book has been exported
 ```
 
 ### Exporting PDF with DocRaptor
 
-After exporting your files (you can use `--only pdf` for this), upload files to somewhere public, possibly your [Dropbox](http://dropbox.com) account. You can even use curl; since the command is quite long, you can view it at <https://gist.github.com/fnando/de555a08e7aab14a661a>.
+After exporting your files (you can use `--only pdf` for this), upload files to
+somewhere public, possibly your [Dropbox](http://dropbox.com) account. You can
+even use curl; since the command is quite long, you can view it at
+<https://gist.github.com/fnando/de555a08e7aab14a661a>.
 
-[^1]: Depend on Prince, html2text and KindleGen being available on your `$PATH`.
+[^1]: Depend on Prince and Calibre being available on your `$PATH`.