pretty_doc 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 005bbc9c34b1951066f640201f2784cfb7cc0cbd
-  data.tar.gz: f240c8fa986a8370a91e6c27ad879430347e0b23
+  metadata.gz: a24955a90cc4b2b627cd6e9f998feff294d6b086
+  data.tar.gz: 04f1a2c4f45411c775aa13decdab38d4ccf5bea3
 SHA512:
-  metadata.gz: 83d3a675a5c9955a65491e7bac099231ff31e76f15cc8a090008a3fffcab2b6e0a4a6a44823e185acd7f6aea31f01f4e75e1ae1eb7eb65727647b11ff05f45e0
-  data.tar.gz: 2a8cf1109911faf61037146e9f8788386d42ccfaa6863d4fdb9719ac4af3062731010c255ced7692c6454a20fe38e73d2705a7cfa0d5efb3996a801bdf623c8f
+  metadata.gz: 84be63c2098f72bb9f79b767f242ad849579af0585980f8c39d88fccb6aeb75e143de225a09cfddb89a5972d8a1a6402037949accaee9af6d7fa7390a3903321
+  data.tar.gz: 1aa3bc7a648203cc1d9069951674a89a74bf49a115fee08cacab4036e2a805ca9cc494a1de7e07fa08bdc99143858ac068495437664c4d0ba87b418a8bcf3f4a

data/CHANGES.md

@@ -1,6 +1,11 @@
+1.0.3
+-----------
+- Fix `GBK` encoding error on windows
+- Adjust default output dir to `./out`
+
 1.0.2
 -----------
-- fix parallel style for image, video tag
+- Fix parallel style for image, video tag
 
 1.0.1
 -----------

data/README.md

@@ -43,6 +43,24 @@ gem install pretty_doc
 #     -h, --help                       output usage information
 ```
 
+## Generate TOC
+
+Use `[TOC]` or `{:toc}` in your markdown file to generate table of contents and use `[NO_TOC]` or `{:.no_toc}` to ignore specific header.
+
+Example:
+
+```
+Pretty Doc
+==========
+[NO_TOC]
+
+[TOC]
+
+## Feature
+
+## Usage
+```
+
 ## Create a custom template
 
 template structure
@@ -56,3 +74,6 @@ template structure
 ## TODO
 
 + Add docs for how to create a custom template
++ Add file toc support
++ Optimize templates for Windows
++ Add custom fonts and javascripts supports

data/build.sh

@@ -1,7 +1,11 @@
+git checkout gh-pages
+
 pretty_doc -t default -o ./examples/default README.md
 pretty_doc -t bootstrap -o ./examples/bootstrap README.md
 pretty_doc -t parallel -o ./examples/parallel README.md
 
-pretty_doc -t parallel README.md
+pretty_doc -t parallel README.md -o .
 
 mv README.html index.html
+
+git checkout master

data/lib/pretty_doc/cli.rb

@@ -4,11 +4,12 @@ require 'pretty_doc'
 
 module PrettyDoc
   class Cli
+    DEFAULT_OUTPUT_DIR = './out'
     class << self
       def run!(args)
         options = OpenStruct.new
         options.template = 'default'
-        options.output = File.expand_path('.')
+        options.output = output_dir(DEFAULT_OUTPUT_DIR)
         options.files = []
         options.enable_line_numbers = false
 
@@ -30,19 +31,16 @@ module PrettyDoc
             exit
           end
 
-          opts.on('-o', '--output [path]', 'output to a given folder') do |o|
-            options.output = File.expand_path(o || '.')
-            if !Dir.exist? options.output
-              puts "Directory #{options.output} is not exists, creating new..."
-              FileUtils.mkdir_p(options.output)
-            end
+          opts.on('-o', '--output [path]', 'output to a given folder, default is `./out`') do |o|
+            options.output = output_dir(o || DEFAULT_OUTPUT_DIR)
+
           end
 
           opts.on('-t', '--template [folder]', 'choose a template') do |tmpl|
             options.template = tmpl
           end
 
-          opts.on('-l', '--line-numbers', 'enable line numbers for codes') do
+          opts.on('-l', '--line-numbers', 'enable line numbers for code highlight') do
             options.enable_line_numbers = true
           end
         end
@@ -69,6 +67,18 @@ module PrettyDoc
         options.template = PrettyDoc.template(options.template)
         PrettyDoc::Resource::Source.build(options)
       end
+
+      private
+
+      def output_dir(path)
+        path = File.expand_path(path)
+        if !Dir.exist? path
+          puts "Directory #{path} is not exists, creating new..."
+          FileUtils.mkdir_p(path)
+        else
+          path
+        end
+      end
     end
   end
 end

data/lib/pretty_doc/resources/source.rb

@@ -10,7 +10,7 @@ module PrettyDoc
         self.file = file
         extname = File.extname(file)
         self.basename = File.basename(file, extname)
-        converter.content = File.read(self.file)
+        converter.content = File.read(self.file, encoding: 'utf-8')
         converter.options = options
         self.content = converter.as_html
       end

data/lib/pretty_doc/version.rb

@@ -1,3 +1,3 @@
 module PrettyDoc
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/templates/parallel/style.scss

@@ -407,12 +407,12 @@ ul.sections > li > div {
   }
 
   #container {
-    left: 28%;
-    width: 72%;
+    left: 24%;
+    width: 76%;
   }
 
   #markdown-toc {
-    width: 24%;
+    width: 20%;
   }
 
   #background {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretty_doc
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - lyfeyaj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri