mkwebook 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7e29166ba302805e68e70779ef8de58870671aab0ae684d1cec2290f5a0b4bf
-  data.tar.gz: 5e530d48d11ce6c26ac5255b7b294b15b6f90bde7b4ecc4e36ee2bc0e0ea7d54
+  metadata.gz: 0caf9753412a2f7479f03a442361ad896c31982ca7225f604311f286d1111685
+  data.tar.gz: 2502a70592588c4b2e62c3c36a5ae38b9801109ac8a8eba3d449f9be50088261
 SHA512:
-  metadata.gz: 1b90f0fbd51ad20e65847ca7fde950fc40651c3639a24f28b73c52580547e19e9b93f8e8a60247e3d56046afd2cfb9d758a5903c569b871093c841ad2513a52b
-  data.tar.gz: f5f17d96c4700ddd423fffe592a702812049a21e65ee113cccf12ba5c38b3dbc8af9a1307711ec96c03e4757e12a68c586e15497d33ccbf99e036078962e7cca
+  metadata.gz: c32259253e673b94040eea46bcbbd4356b5dcc9622943892c32a343029863eb6c059e7a6b45981d3c03e8fc90a7aaf475f5d952d2e4fa315796f5658dcb1e7b4
+  data.tar.gz: f18163c7ec7a720ba600ae9d3a66d48f7df350d3c59dfd2b903f17bdeacc81bf419e6e1ecab858ee26c674078ed853c3f60c99a70643f01f9b100546828a324b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mkwebook (0.1.2)
+    mkwebook (0.1.3)
       activesupport (>= 6.1.5)
       concurrent-ruby
       ferrum (>= 0.13)

data/lib/mkwebook/version.rb

@@ -1,3 +1,3 @@
 module Mkwebook
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/template/mkwebook.yml

@@ -1,49 +1,49 @@
-browser:  # browser settings
-  headless: false  # headless mode
-  window_size: [1440, 1024] # browser window size
+browser:  # browser settings, this setting is optional
+  headless: false  # headless mode, the -H CLI option could be used to override this setting
+  window_size: [1920, 1200] # browser window size
   timeout: 30 # timeout for waiting for page loading
   # Any options accepted by Ferum::Browser.new are allowed here
 
 concurrency: 16  # number of concurrent threads, default is no conccurency
 
-authentication:  # authentication settings
+authentication:  # authentication settings, this setting is optional
   url: https://example.com/login # any page url which for inject cookie and local storage
   cookies: "auth_cookie_id=demo" # cookie string to be injected
   local-storage:  # local storage to be injected
     username: demo  # key and value
     auth_token: demo  # key and value
 
-index-page:  # index page settings
+index-page:  # index page settings, this setting is mandatory
   url: https://clojure.org/guides/repl/introduction  # URL of index page
   title: Clojure Guides  # title for the book, use page's title if not set
-  modifier: |  # JavaScript code to modify the page
+  modifier: |  # JavaScript code to modify the page, this setting is optional
     document.body.innerHTML = document.querySelector('.clj-section-nav-container').outerHTML;
     document.querySelector('.clj-section-nav-container').style.width = '100%';
     document.body.style.backgroundColor = 'white';
 
-  selector: "html"  # CSS selector for the content to be saved
-  output: "index.html" # output file name
-  link-selector: "a:not([href='../guides'])"  # CSS selector for links of content pages
-  assets:  # assets to be downloaded
+  selector: "html"  # CSS selector for the content to be saved, this setting is mandatory
+  output: "index.html" # output file name, this setting is mandatory
+  link-selector: "a:not([href='../guides'])"  # CSS selector for links of content pages, this setting is mandatory
+  assets:  # assets to be downloaded, this setting is optional
     - selector: "link[rel=stylesheet]" # CSS selector for assets
       attr: href  # attribute name for the asset URL
     - selector: "script[src]"
       attr: src
 
-max-recursion: 2  # max depth of recursive downloading
+max-recursion: 2  # max depth of recursive downloading, default is 1
 
-pages:  # settings for content pages
+pages:  # settings for content pages, this setting is mandatory
   - url-pattern: '.*'  # URL pattern for content page, only pages' URL matching this pattern will be processed
-    modifier: |  # JavaScript code to modify the page
+    modifier: |  # JavaScript code to modify the page, this setting is optional
       document.body.innerHTML = document.querySelector('.clj-content-container').outerHTML;
       document.querySelector('.clj-content-container').style.width = '100%';
       document.body.style.backgroundColor = 'white';
       var style = document.createElement('style');
       style.innerHTML = '.clj-content-container { margin-left: 0; }';
       document.body.appendChild(style);
-    selector: html   # CSS selector for the content to be saved
-    page-link-selector: "a:not([href='../guides'])"  # links to be downloaded recursively which are extracted from page content
-    assets:  # assets to be downloaded
+    selector: html   # CSS selector for the content to be saved, this setting is mandatory
+    page-link-selector: "a:not([href='../guides'])"  # links to be downloaded recursively which are extracted from page content, this setting is optional, if this setting is set, consider also set max-recursion
+    assets:  # assets to be downloaded, this setting is optional
       - selector: img  # CSS selector for assets
         attr: src  # attribute name for the asset URL
       - selector: "link[rel=stylesheet]"
@@ -51,20 +51,20 @@ pages:  # settings for content pages
       - selector: "script[src]"
         attr: src
 
-extra-pages:  # settings for extra pages
+extra-pages:  # settings for extra pages, this setting is optional
   - https://www.example.com/extra-page-1
 
-post-process: |  # Shell script to be executed after the book is downloaded
+post-process: |  # Shell script to be executed after the book is downloaded, this setting is optional
   find . -name '*.html' -exec sed -i 's/https:\/\/clojure.org\/guides\/repl\/introduction/..\/index.html/g' {} \;
             
-docset:  # config for generate docset
-  name: "Clojure Guides"  # docset name
-  keyword: "clojure"  # docset keyword
-  icon: "clojure.png"  # docset icon
-  index: "/index.html"  # docset index page
+docset:  # config for generate docset, mandatory if run docset command
+  name: "Clojure Guides"  # docset name, this setting is mandatory
+  keyword: "clojure"  # docset keyword, this setting is mandatory
+  icon: "clojure.png"  # docset icon, this setting is mandatory
+  index: "/index.html"  # docset index page, this setting is mandatory
   pages:  # docset pages config
   - url-pattern: 'index.html'  # URL pattern for docset page, will match against local downloaded pages
-    extractor: |  # JavaScript code to extract the content for docset page
+    extractor: |  # JavaScript code to extract the content for docset page, this setting is mandatory
       (function() {
         var links = [...document.querySelectorAll('a.data-url')];
         return links.map(link => {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mkwebook
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Liu Xiang