adocsite 1.0.4 → 1.0.5

data/README.md

@@ -1,4 +1,8 @@
-# ADocSite in a few words
+# adocsite
+
+[![Gem Version](https://badge.fury.io/rb/adocsite.svg)](http://badge.fury.io/rb/adocsite)
+
+## ADocSite in a few words
 
 The idea behind this gem is this:
 
@@ -15,7 +19,7 @@ and generates one simple static web site out of it.
 
 Now you can go, open index.html and browse through all those documents of yours and view them as web pages.
 
-# Some more details 
+## Some more details 
 
 ADocSite is implemented in [Ruby](https://www.ruby-lang.org/en/). It expects that all files with content are 
 written as [asciidoc](http://www.methods.co.nz/asciidoc/) text files. These files are converted into HTML using [asciidoctor](http://asciidoctor.org/).
@@ -52,8 +56,6 @@ That's it.
 
 Really.
 
-[Here, let me show you...](http://myblueraven.com/adocsite).
-
 
 ## Installation
 
@@ -71,7 +73,113 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+OK! So, you can do these things with adocsite:
+
+    $ adocsite
+    $ adocsite build
+    $ adocsite dump
+
+First two are identical: calling adocsite without parameters is same as asking it to do build.
+
+### adocsite dump
+
+If you run this command you will get adocsite to dump it's templates and configurations into current folder. So, after running:
+
+    $ adocsite dump
+
+you will end up with:
+
+* folder **adocsite__default__templates** which will contain all HAML adocsite templates
+* file **adocsite__default__config.rb** which contains adocsite default configuration
+* file **adocsite__custom__config__sample.rb** with example of custom configuration for site builder
+* file **adocsite__wp__config__sample.rb** with example of custom configuration for wordpress article poster (heavy beta phase, avoid it for now :o)
+
+These can be your starting point for customizing/configuring adocsite output to your liking.
+
+### adocsite build
+
+Create folder to work in (let's say it's called "Documents")
+
+    $ mkdir Documents
+    $ cd Documents
+
+Create folders in there to hold your stuff:
+
+    $ mkdir work
+    $ mkdir docs
+
+Collect all your adoc documents into **work** and/or **docs** folder(s) you created in previous step.
+
+Run adocsite:
+
+    $ adocsite
+
+After build is finished there will be new folder in **Documents** called **deploy**. There you can find output of adocsite's hard work. Open deploy/index.html in your browser and check out the results.
+
+#### customize the build
+
+If you would like to change what can be changed in adocsite, then first run
+
+    $ adocsite dump
+
+to get templates and default configs from adocsite.
+
+Then you can make your own config file with custom settings (i.e. different names for folder(s) where you keep your documents, instead of default **work** and **docs**) or you can tweak existing or create new templates.
+
+With config files you can do two things:
+
+1. save them in the folder you use to run adocsite in (i.e. **Documents** from above example)
+2. save them in your $HOME folder with names **.adocsite** and **.adocsite_wp** (notice the dot at the start)
+
+If you choose 1. then you need to tell adocsite to use that config file by running it like this
+
+    $ adocsite build --config my_custom_config.rb
+
+or
+
+    $ adocsite --config my_custom_config.rb
+
+If you choose 2. then your custom configuration files will be used **always** when you run adocsite like usual:
+
+    $ adocsite
+
+or
+
+    $ adocsite build
+
+#### custom templates
+
+If you choose to edit/create new HAML templates for adocsite, first dump the ones adocsite uses and start there. Templates folder contains subfolders whose names are used as names of layouts. Default layout will be taken from subfolder named, yes, **default**. If you want to choose different layout run adocsite like this:
+
+    $ adocsite --layout adoc
+
+This way adocsite will use templates from subfolder named **adoc** for building output.
+
+If you make your own changes then
+
+1. create templates folder (or rename one dumped by adocsite)
+2. create subfolder **default**
+3. put your templates in **default** subfolder
+4. make/modify adocsite config file to tell it where new templates are
+5. run adocsite using your custom config file
+
+i.e. put in your config file line like this:
+
+    :TEMPLATES_FOLDER => "/home/username/Documents/tpl",
+
+and then run adocsite like this
+
+    $ adocsite --config my_config.rb
+
+If you have more than one template layout (i.e. more subfolders in templates folder) choose between them like this:
+
+    $ adocsite --config my_config.rb --layout blue_boxed
+
+or
+
+    $ adocsite --config my_config.rb --layout orange
+
+etc.
 
 ## Contributing
 

data/adocsite.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["bb@myblueraven.com"]
   spec.summary       = %q{Static site generator.}
   spec.description   = %q{Very simple static site generator for asciidoc documents.}
-  spec.homepage      = "http://myblueraven.com/adocsite"
+  spec.homepage      = "https://github.com/myblueraven/adocsite#adocsite"
   spec.license       = "GPL v3"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/adocsite/commands.rb

@@ -9,7 +9,7 @@ module Adocsite
 
     def Commands.dump(args, options)
       # default template
-      FileUtils.cp_r(Adocsite.config[:TEMPLATES_FOLDER], "adocsite_default_template")
+      FileUtils.cp_r(Adocsite.config[:TEMPLATES_FOLDER], "adocsite_default_templates")
 
       # default configuration
       conf = <<-EOS

data/lib/adocsite/version.rb

@@ -1,3 +1,3 @@
 module Adocsite
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/tpl/adoc/layouts/compact.haml

@@ -2,8 +2,8 @@
   %head
     %title= page_title
     %script{:src => 'js/asciidoc.js'}
-    %script{:src => 'js/myblueraven.js'}
-    %link{:rel => 'stylesheet', :media => "screen", :href => 'css/myblueraven.css'}
+    %script{:src => 'js/adocsite.js'}
+    %link{:rel => 'stylesheet', :media => "screen", :href => 'css/adocsite.css'}
   %body
     #page
       #header

data/tpl/adoc/layouts/default.haml

@@ -2,8 +2,8 @@
   %head
     %title= page_title
     %script{:src => 'js/asciidoc.js'}
-    %script{:src => 'js/myblueraven.js'}
-    %link{:rel => 'stylesheet', :media => "screen", :href => 'css/myblueraven.css'}
+    %script{:src => 'js/adocsite.js'}
+    %link{:rel => 'stylesheet', :media => "screen", :href => 'css/adocsite.css'}
   %body
     #page
       #header

data/tpl/default/layouts/default.haml

@@ -4,9 +4,9 @@
     %title= page_title
     %script{:src => 'https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js'}
     %script{:src => 'js/bootstrap.min.js'}
-    %script{:src => 'js/myblueraven.js'}
+    %script{:src => 'js/adocsite.js'}
     %link{:rel => 'stylesheet', :media => "screen", :href => 'css/bootstrap.min.css'}
-    %link{:rel => 'stylesheet', :media => "screen", :href => 'css/myblueraven.css'}
+    %link{:rel => 'stylesheet', :media => "screen", :href => 'css/adocsite.css'}
   %body
     #page.container
       #header.row

metadata

@@ -1,134 +1,173 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: adocsite
-version: !ruby/object:Gem::Version
-  version: 1.0.4
+version: !ruby/object:Gem::Version 
+  hash: 29
   prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 5
+  version: 1.0.5
 platform: ruby
-authors:
+authors: 
 - Bruce Brennan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-28 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2015-04-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: haml
-  requirement: &79848820 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79848820
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: asciidoctor
-  requirement: &79848610 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79848610
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: tilt
-  requirement: &79848400 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79848400
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: commander
-  requirement: &79848190 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79848190
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: rubypress
-  requirement: &79847980 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79847980
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: nokogiri
-  requirement: &79847770 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79847770
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: terminal-table
-  requirement: &79847560 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79847560
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: mime-types
-  requirement: &79847350 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79847350
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &79847100 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
   type: :development
-  prerelease: false
-  version_requirements: *79847100
-- !ruby/object:Gem::Dependency
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &79846890 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *79846890
+  version_requirements: *id010
 description: Very simple static site generator for asciidoc documents.
-email:
+email: 
 - bb@myblueraven.com
-executables:
+executables: 
 - adocsite
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -165,12 +204,12 @@ files:
 - tpl/adoc/partials/category.haml
 - tpl/adoc/partials/home.haml
 - tpl/adoc/partials/page.haml
+- tpl/adoc/resources/css/adocsite.css
 - tpl/adoc/resources/css/asciidoctor.css
 - tpl/adoc/resources/css/funky.css
 - tpl/adoc/resources/css/kernel.css
-- tpl/adoc/resources/css/myblueraven.css
+- tpl/adoc/resources/js/adocsite.js
 - tpl/adoc/resources/js/asciidoc.js
-- tpl/adoc/resources/js/myblueraven.js
 - tpl/adoc/resources/js/sleepy.js
 - tpl/default/includes/footer.haml
 - tpl/default/includes/header.haml
@@ -182,38 +221,47 @@ files:
 - tpl/default/partials/category.haml
 - tpl/default/partials/home.haml
 - tpl/default/partials/page.haml
+- tpl/default/resources/css/adocsite.css
 - tpl/default/resources/css/bootstrap-theme.min.css
 - tpl/default/resources/css/bootstrap.min.css
-- tpl/default/resources/css/myblueraven.css
 - tpl/default/resources/fonts/glyphicons-halflings-regular.eot
 - tpl/default/resources/fonts/glyphicons-halflings-regular.svg
 - tpl/default/resources/fonts/glyphicons-halflings-regular.ttf
 - tpl/default/resources/fonts/glyphicons-halflings-regular.woff
+- tpl/default/resources/js/adocsite.js
 - tpl/default/resources/js/bootstrap.min.js
-- tpl/default/resources/js/myblueraven.js
-homepage: http://myblueraven.com/adocsite
-licenses:
+homepage: https://github.com/myblueraven/adocsite#adocsite
+licenses: 
 - GPL v3
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Static site generator.
 test_files: []
+