asciibook 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ae7901e0269a4751c07d64a9ba27e0f2cca49e2b19614e846b683c12fedd0e5
-  data.tar.gz: 07d770921a2684ff557fa6c6add31b9bd0744a4b4b264bb7796ea2affeadfc4e
+  metadata.gz: ac1b2f6cc55318830a04ebb0c2051e075ead0a2cd24a66ae9b77a97f04e8727e
+  data.tar.gz: af327832e1592d2b99f455e41f4d3c32370988d20adc3b6c05b54146e3416343
 SHA512:
-  metadata.gz: 26a0d7fae1562efe4afee1c4f7cac18bbf94364da4ef8b4a98298f682bfa5387560d6cb8bcd468fc5427559bd9970429d7e70bb8ccfe55089894de38e9ec09af
-  data.tar.gz: 10199b8d5b7443564bdb8de86953211623713970ea092ef0cc633ef4d5d32d97d2c51643029511779a43aa0c9ae5a016e0fe6b2d5098869d1b3cf91e83faa1b6
+  metadata.gz: c7a0ea1bd7f7e059f26f339083d11bea1795defd89e8ab06401deb3e0708abdc78a51b87712d45d1e23848d98b7a68311bcbef0fb6f3abfeca85f345182551a2
+  data.tar.gz: 811f7da4d3876bd5a76ceb5f63ccb61bbc31e13baaeaf6bcfde1177ef435487ea897c9c879451cd027821a9c90f60fe633d3c5b774f844b9fdc9fdc2d1d84e78

data/README.adoc

@@ -5,88 +5,58 @@ Asciibook is an Ebook generator for converting AsciiDoc to HTML, PDF, EPUB and M
 
 == Installation
 
-If you are familiar with Ruby, you can use <<manual-installation>>.
+Asciibook uses docker as distribution tool. Docker helps deal with dependencies, keeps the local environment clean, and works well with CI / CD tools.
 
-If your are familiar with Docker, you can use <<docker-installation>>.
+You can download and install docker in https://www.docker.com/products/docker-desktop .
 
-[[manual-installation]]
-=== Manual installation
-
-Install by rubygems:
-
-[source, console]
-----
-$ gem install asciibook
-----
-
-For PDF generate, download and install wkhtmltopdf in https://wkhtmltopdf.org/downloads.html .
-
-For Mobi generate, download and install kindlegen in https://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211 .
-
-
-[[docker-installation]]
-=== Docker Installation
-
-Pull docker image:
+After installed docker, Pull the docker image:
 
 [source, consle]
 ----
 $ docker pull asciibook/asciibook
 ----
 
-Then use asciibook CLI in this way:
-
-[source, console]
-----
-$ docker run -v $(pwd):/asciibook asciibook/asciibook asciibook build mybook.adoc
-----
-
-Or enter the container environment to avoid repeating lengthy commands:
-
-[source, console]
-----
-$ docker run -v $(pwd):/asciibook asciibook/asciibook bash
-/asciibook $ asciibook build mybook.adoc
-----
-
 == Usage
 
-For a existing AsciiDoc file, run this command to build all format books:
+First, enter container enviroment in your AsciiDoc file diretory:
 
 [source, console]
 ----
-$ ascibook build mybook.adoc
+$ docker run -it -v $(pwd):/asciibook asciibook/asciibook bash
+/asciibook #
 ----
 
-Generated books will put in `build` directory.
+Following command is executed inside the container environment.
 
-Or generate only partial format:
+For a existing AsciiDoc file, run this command to build all formats:
 
 [source, console]
 ----
-$ asciibook build mybook.adoc --format html
-$ asciibook build mybook.adoc --format pdf,mobi
+/asciibook # ascibook build mybook.adoc
 ----
 
-If you don't want to enter the parameters repeatedly, you can create a configuration file for the document:
+Generated results will be placed in the `build` folder.
+
+Or generate partial formats:
 
 [source, console]
 ----
-$ asciibook init mybook.adoc
+/asciibook # asciibook build mybook.adoc --format html
+/asciibook # asciibook build mybook.adoc --format pdf,mobi
 ----
 
-It will create a config file `asciibook.yml` in the same directory, edit config for your need, then use this command to build next time:
+If you don't want to type the parameters repeatedly, you can create a configuration file for the document:
 
 [source, console]
 ----
-$ asciibook build
+/asciibook # asciibook init mybook.adoc
 ----
 
-Use this command to create a empty AsciiDoc and config file:
+It will create a config file named `asciibook.yml` in the same directory, edit config for your need, then use this command to build next time:
 
 [source, console]
 ----
-$ asciibook new mybook
+/asciibook # asciibook build
 ----
 
 == Development

data/lib/asciibook/book.rb

@@ -46,21 +46,24 @@ module Asciibook
       doc.attributes['cover-image']
     end
 
-    def toc
-      @toc ||= outline(doc)
+    def outline
+      outline_node(doc)
     end
 
-    def outline(node)
+    # book outline only list sections that split as page
+    def outline_node(node)
       data = []
       node.sections.each do |section|
-        section_data = {
-          'title' => section.xreftext,
-          'path' => section.page ? section.page.path : "#{find_page_node(section).page.path}##{section.id}"
-        }
-        if section.sections.count > 0 and section.level < (doc.attributes['toclevels'] || 2).to_i
-          section_data['items'] = outline(section)
+        if section.page
+          section_data = {
+            'title' => section.xreftext,
+            'path' => section.page.path
+          }
+          if section.sections.count > 0 and section.level < @page_level
+            section_data['items'] = outline_node(section)
+          end
+          data << section_data
         end
-        data << section_data
       end
       data
     end
@@ -79,7 +82,7 @@ module Asciibook
       {
         'title' => doc.attributes['doctitle'],
         'attributes' => doc.attributes,
-        'toc' => toc
+        'outline' => outline
       }
     end
 

data/lib/asciibook/page.rb

@@ -14,7 +14,41 @@ module Asciibook
     end
 
     def content
-      node.convert
+      @content ||= node.convert
+    end
+
+    def doc
+      @doc ||= Nokogiri::HTML.fragment(content)
+    end
+
+    def image_url
+      doc.css('img').first&.attr('src')
+    end
+
+    def description
+      doc.css('p').first&.text
+    end
+
+    def outline
+      outline_node(@node)
+    end
+
+    # page outline only list sections that not split as page
+    def outline_node(node)
+      data = []
+      node.sections.each do |section|
+        if !section.page
+          section_data = {
+            'title' => section.xreftext,
+            'path' => "##{section.id}"
+          }
+          if section.sections.count > 0
+            section_data['items'] = outline_node(section)
+          end
+          data << section_data
+        end
+      end
+      data
     end
 
     def to_hash
@@ -22,6 +56,9 @@ module Asciibook
         'path' => path,
         'title' => title,
         'content' => content,
+        'image_url' => image_url,
+        'description' => description,
+        'outline' => outline,
         'prev_page' => prev_page && { 'path' => prev_page.path, 'title' => prev_page.title },
         'next_page' => next_page && { 'path' => next_page.path, 'title' => next_page.title }
       }

data/lib/asciibook/version.rb

@@ -1,3 +1,3 @@
 module Asciibook
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/templates/admonition.html

@@ -1,5 +1,6 @@
 <div class="admonition admonition-{{ node.attributes.name }}" {% if node.id %}id="{{ node.id }}"{% endif %}>
   <div class="admonition-icon">
+    <b>{{ node.attributes.name | upcase }}</b>
   </div>
   <div class="admonition-content">
     {% if node.title %}<h5>{{ node.title }}</h5>{% endif %}

data/templates/inline_break.html

@@ -0,0 +1 @@
+{{ node.text }}<br/>

data/theme/html/html.css

@@ -1,16 +1,97 @@
-.toolbar {
-  position: fixed;
+html,
+body {
+  height: 100%;
+}
+
+.preload * {
+  -webkit-transition: none !important;
+  -moz-transition: none !important;
+  -ms-transition: none !important;
+  -o-transition: none !important;
+}
+
+.drawer .drawer-content {
+  width: 240px;
+  position: absolute;
   top: 0;
+  left: -240px;
+  bottom: 0;
+  overflow-y: auto;
+  transition: left 0.15s;
+  background: #fafafa;
+  border-right: 1px solid #eee;
+  box-sizing: border-box;
+}
+
+.drawer.open .drawer-content {
   left: 0;
+}
+
+.drawer-menu ol {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+}
+
+.drawer-menu-item {
+  padding: 10px 16px;
+  display: block;
+  text-decoration: none;
+  color: #555;
+  font-size: 14px;
+  line-height: 20px;
+}
+
+.drawer-menu-item:hover {
+  background: rgba(0, 0, 0, 0.05);
+  color: #333;
+}
+
+.drawer-menu-item.active {
+  background: rgba(0, 0, 0, 0.05);
+  color: #3f51b5;
+}
+
+.drawer-menu ol ol .drawer-menu-item {
+  padding-left: 32px;
+}
+
+.main {
+  position: absolute;
+  top: 0;
   right: 0;
-  padding: 0.25em 1.25em;
+  left: 0;
+  bottom: 0;
+  transition: left 0.15s;
+}
+
+.drawer.open + .main {
+  left: 240px;
+}
+
+.main-content {
+  position: absolute;
+  top: 56px;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  overflow-y: auto;
+  padding: 32px;
+  outline: 0;
+}
+
+.container {
+  max-width: 768px;
+  margin: 0 auto;
+}
+
+.toolbar {
+  padding: 4px;
   display: flex;
-  background: white;
-  z-index: 100;
 }
 
 .toolbar-title {
-  padding: 0.75em;
+  padding: 12px;
   flex-grow: 1;
   font-weight: bold;
 }
@@ -25,7 +106,7 @@
 }
 
 .toolbar-action {
-  padding: 0.25em;
+  padding: 4px;
 }
 
 .button {
@@ -41,24 +122,44 @@
   line-height: 1;
   border: none;
   padding: 0;
+  color: #999;
+}
+
+.button:hover {
+  color: #555;
+}
+
+.button:active,
+.button.active {
+  color: #333;
+}
+
+.button:disabled,
+.button.disabled {
+  pointer-events: none;
+  opacity: 0.5;
+}
+
+.button-text {
+  padding: 8px 16px;
 }
 
 .button-icon {
-  padding: 0.5em;
+  padding: 8px;
+  border-radius: 50%;
 }
 
 .button-icon {
-  color: #999;
+  fill: #999;
 }
 
 .button-icon:hover {
-  color: #555;
+  fill: #555;
 }
 
-.button-icon .fas {
-  font-size: 1.25em;
-  width: 1.2em;
-  line-height: 1.2em;
+.button-icon {
+  width: 40px;
+  height: 40px;
   text-align: center;
 }
 
@@ -69,7 +170,7 @@
 .dropdown-menu {
   display: none;
   position: absolute;
-  min-width: 320px;
+  min-width: 240px;
   max-width: 90%;
   max-height: 480px;
   top: 100%;
@@ -79,6 +180,7 @@
   z-index: 10;
   overflow-y: auto;
   background: white;
+  font-size: 14px;
 }
 
 .dropdown.open .dropdown-menu {
@@ -93,9 +195,10 @@
 
 .dropdown-menu-item {
   display: block;
-  padding: 12px;
+  padding: 10px 12px;
   text-decoration: none;
   color: #555;
+  line-height: 20px;
 }
 
 .dropdown-menu-item:hover {
@@ -111,10 +214,54 @@
   padding-left: 24px;
 }
 
-.content {
-  padding: 2em;
-  max-width: 768px;
-  margin: 0 auto;
+.dropdown-group {
+  margin: 16px;
+}
+
+.dropdown-group label {
+  display: block;
+  margin-bottom: 8px;
+  font-weight: bold;
+  color: #777;
+}
+
+.dropdown-options {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.font-family-options .button {
+  justify-content: center;
+  flex-grow: 1;
+}
+
+.background-options .button {
+  border: 1px solid #ccc;
+}
+
+.background-options .button svg {
+  display: none;
+}
+
+.background-options .button.active svg {
+  display: block;
+}
+
+.background-options .button[data-value="white"] {
+  background: white;
+}
+
+.background-options .button[data-value="warm"] {
+  background: #fff8e1;
+}
+
+.background-options .button[data-value="dim"] {
+  background: #424242;
+}
+
+.background-options .button[data-value="black"] {
+  background: black;
 }
 
 .paginator {
@@ -122,19 +269,15 @@
 
 .paginator a {
   padding: 32px;
-  color: #999;
+  fill: #999;
   text-decoration: none;
 }
 
-.paginator a .fas {
-  font-size: 1.25em;
-  width: 1.2em;
-  line-height: 1.2em;
-  text-align: center;
+.paginator a svg {
 }
 
 .paginator a:hover {
-  color: #555;
+  fill: #555;
 }
 
 .paginator a.disabled {
@@ -145,8 +288,9 @@
   display: flex;
   flex-direction: column;
   justify-content: center;
-  position: fixed;
-  top: 48px;
+  align-items: center;
+  position: absolute;
+  top: 56px;
   bottom: 0;
   left: 0;
 }
@@ -155,23 +299,188 @@
   display: flex;
   flex-direction: column;
   justify-content: center;
-  position: fixed;
-  top: 48px;
+  align-items: center;
+  position: absolute;
+  top: 56px;
   bottom: 0;
   right: 0;
 }
 
-.main {
-  margin-top: 56px;
+/* Theme */
+
+body[data-font-size="50"] .main-content {
+  font-size: 50%;
+}
+
+body[data-font-size="67"] .main-content {
+  font-size: 67%;
+}
+
+body[data-font-size="75"] .main-content {
+  font-size: 75%;
+}
+
+body[data-font-size="80"] .main-content {
+  font-size: 80%;
+}
+
+body[data-font-size="90"] .main-content {
+  font-size: 90%;
+}
+
+body[data-font-size="100"] .main-content {
+  font-size: 100%;
+}
+
+body[data-font-size="110"] .main-content {
+  font-size: 110%;
+}
+
+body[data-font-size="125"] .main-content {
+  font-size: 125%;
+}
+
+body[data-font-size="150"] .main-content {
+  font-size: 150%;
+}
+
+body[data-font-size="175"] .main-content {
+  font-size: 175%;
+}
+
+body[data-font-size="200"] .main-content {
+  font-size: 200%;
+}
+
+body[data-font-family="serif"] .main-content {
+  font-family: serif;
+}
+
+body[data-font-family="sans-serif"] .main-content {
+  font-family: sans-serif;
+}
+
+body[data-background="white"] {
+  background: white;
+}
+
+body[data-background="warm"] {
+  background: #fff8e1;
+}
+
+body[data-background="dim"] {
+  background: #424242;
+}
+
+body[data-background="dim"] .main-content,
+body[data-background="dim"] .main-content h1,
+body[data-background="dim"] .main-content h2,
+body[data-background="dim"] .main-content h3,
+body[data-background="dim"] .main-content h4,
+body[data-background="dim"] .main-content h5,
+body[data-background="dim"] .main-content h6 {
+  color: #ddd;
+}
+
+body[data-background="dim"] .main-content pre,
+body[data-background="dim"] .main-content *:not(pre) code,
+body[data-background="dim"] .main-content .example,
+body[data-background="dim"] .main-content .sidebar,
+body[data-background="dim"] .main-content blockquote {
+  background: transparent;
+}
+
+body[data-background="dim"] .main-content pre span {
+  color: #ddd;
+}
+
+body[data-background="dim"] .main-content a {
+  color: #81d4fa;
+}
+
+body[data-background="dim"] .main-content a.callout {
+  color: #ddd;
+}
+
+body[data-background="black"] {
+  background: black;
+}
+
+body[data-background="black"] .main-content,
+body[data-background="black"] .main-content h1,
+body[data-background="black"] .main-content h2,
+body[data-background="black"] .main-content h3,
+body[data-background="black"] .main-content h4,
+body[data-background="black"] .main-content h5,
+body[data-background="black"] .main-content h6 {
+  color: #ddd;
+}
+
+body[data-background="black"] .main-content pre,
+body[data-background="black"] .main-content *:not(pre) code,
+body[data-background="black"] .main-content .example,
+body[data-background="black"] .main-content .sidebar,
+body[data-background="black"] .main-content blockquote {
+  background: transparent;
 }
 
-@media (max-width: 992px) {
+body[data-background="black"] .main-content pre span {
+  color: #ddd;
+}
+
+body[data-background="black"] .main-content a {
+  color: #81d4fa;
+}
+
+body[data-background="black"] .main-content a.callout {
+  color: #ddd;
+}
+/* responsive */
+
+@media (max-width: 1280px) {
+  .drawer.open .drawer-content {
+    z-index: 20;
+    background: white;
+  }
+
+  .drawer .drawer-backdrop {
+    display: none;
+  }
+
+  .drawer.open .drawer-backdrop {
+    display: block;
+    position: absolute;
+    top: 0;
+    left: 0;
+    right: 0;
+    bottom: 0;
+    z-index: 10;
+    background: rgba(0, 0, 0, 0.15);
+  }
+
+  .drawer.open + .main {
+    left: 0;
+  }
+
+  .drawer.open .drawer-content {
+    border: none;
+    box-shadow: 0 0 4px rgba(0, 0, 0, 0.3);
+  }
+
+  .main-content {
+    bottom: 56px;
+  }
+
   .paginator {
     display: flex;
+    position: absolute;
+    bottom: 0;
+    left: 0;
+    right: 0;
   }
 
   .paginator a {
-    padding: 1em;
+    padding: 16px;
   }
 
   .paginator-prev {
@@ -188,15 +497,7 @@
 }
 
 @media (max-width: 480px) {
-  .toolbar {
-    padding: 0.25em;
-  }
-
-  .content {
-    padding: 1em;
-  }
-
-  .paginator a {
-    padding: 0.25em;
+  .main-content {
+    padding: 16px;
   }
 }