textigniter 0.0.3 → 0.0.31

data/README.textile

@@ -1,6 +1,6 @@
 h1. Textigniter
 
-Textigniter is a command line tool used to generate static websites. The main point of configuration is the config.yml that is set up in a textigniter initialized directory.  Textigniter comes default with textile, liquid, less, and coffee-script as parsers to output static content.
+Textigniter is a command line tool used to generate static websites. Textigniter uses the power of "Textile":http://redcloth.org/ ("Markdown":http://kramdown.rubyforge.org/ is optional...), "Liquid":http://liquidmarkup.org/, "LESS CSS":http://lesscss.org/, and "Coffee Script":http://jashkenas.github.com/coffee-script/ for parsing different files and outputting "HTML5":http://www.html5rocks.com/en/ powered websites (Obviously you'll need to know HTML5, textigniter just helps with a development philosophy). 
 
 h2. Installation
 
@@ -13,16 +13,67 @@ The default parser gem's will be downloaded as well.
 h2. Usage
 
 @textigniter init@
+
 @textigniter init directory@
 
 Passing the init option initializes a new textigniter environment in your current directory. You can pass a second option to specify a directory that you want to install textigniter in.
 
 @textigniter build@
 
-Passing the build option will make textigniter parse the _.textigniter_ directory and output the static html to _public_html_
+Passing the build option will make textigniter parse the _.textigniter_ directory and output the static html to _output_
 
 @textignier scrub@
-When you pass the scrub option, all textigniter related files and folders will be removed.  This will also remove _public_html_. If you have files not related to textigniter specifically in the _public_html_ folder, you should back them up if you do not want to lose them.
+
+When you pass the scrub option, all textigniter related files and folders will be removed.  This will also remove _output_. If you have files not related to textigniter specifically in the _output_ folder, you should back them up if you do not want to lose them.
 
 @textigniter help@
-Passing help on the command line will print out usage of _textigniter_
+
+Passing help on the command line will print out usage of _textigniter_
+
+h2. Configuration
+
+You can add anything you wish to _config.yml_ as long as it follows YAML format.  Anything added to this file is available in the template. Look under the Template heading to find out more.
+
+h2. Content
+
+Content is stored in text files instead of a database.  You can find a default _index.textile_ and _about.textile_ under the _.textigniter/content_ folder. 
+Your folder structure will determine your site structure. If you wanted a link that was _yoursite.com/articles/textigniter_, your folder and file structure would be _.textigniter/content/articles/textigniter.textile_. If you decide to use markdown instead of textile, make sure to update _config.yml_ with the correct _text_parser_ and change your file extensions from _.textile_ to _.markdown_.
+
+These text files are broken down into a meta section and sections delimited by @-- content@, @-- variable_name@.  The meta is parsed with YAML and the other sections are parsed with Textile. You can use any variable name you want for the text section and they'll be available to the template parser.  This is true for the meta section as well. An example file could look something like this:
+
+@title: Textigniter@
+@slug: textigniter@
+@tags: static, content, html5@
+@author: Kaleb Heitzman@
+@-- content@
+@h1. This is textigniter powered@
+@-- sidebar@
+@h3. This is some sidebar content@
+
+The following variables would be available in the template according to the code above: {{ title }}, {{ slug }}, {{ tags }}, {{ author }}, {{ content }}, {{ sidebar }}.
+
+h2. Templates
+
+Textigniter uses _liquid_ templates.  Anything that goes in liquid can go in textigniter.  Checkout the "liquid documentation.":https://github.com/Shopify/liquid/wiki/Liquid-for-Designers
+
+Anything in _config.yml_ and the textile(markdown) file is available to the template. For example, _site_name_ is declared in the config file and is available in the template file as {{ site_name }}
+
+h2. Styles
+
+Styles are parsed via less. You can create .less files under _.textigniter/styles_ with a .less extension and they will automatically be parsed.
+
+See the "LESS usage documentation":http://lesscss.org/#synopsis for more information.
+
+h2. Scripts
+
+Scripts are parsed via coffeescript. You can create .coffeescript files under _.textigniter/scripts_ with a .coffeescript extension and they will automatically be parsed.
+
+See the "CoffeeScript homepage":http://jashkenas.github.com/coffee-script/ for more information.
+
+h2. Philosophy
+
+HTML5 is the rising up comer and with it come many advantages that in my opinion make databases overused for a majority of websites (Bloggers/Brochure Sites).  Most dynamic content doesn't need pulled from a database anymore because it can processed with Javascript and XML, i.e Twitter feeds. Static Site Generators can really excel in this area.
+
+A moment of honesty.  Modular systems are awesome but systems are not created equal.  Textigniter has been created with this in mind.  Textigniter uses "Textile":http://redcloth.org/ ("Markdown":http://kramdown.rubyforge.org/ is optional...), "Liquid":http://liquidmarkup.org/, "LESS CSS":http://lesscss.org/, and "Coffee Script":http://jashkenas.github.com/coffee-script/ for parsing different files and outputting static content. 
+
+Static content mixed with the power of Javascript and HTML5 is more than enough for a majority of users who want easily maintainable websites.

data/lib/skeleton/.textigniter/content/about.textile

@@ -1,5 +1,6 @@
 title: About
 slug: about
+template: about
 -- content
 This is a sample about page generated by "textigniter":http://github.com/kalebheitzman/textigniter
 -- sidebar

data/lib/skeleton/.textigniter/layouts/about.liquid

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>{{ title }}</title>
+	</head>
+	<body>
+		{{ content }}
+		
+		{{ sidebar }}
+	</body>
+</html>

data/lib/skeleton/config.yml

@@ -1,8 +1,4 @@
 site_name: "Textigniter"
 site_description: "A textigniter powered website"
-textigniter_environment: ".textigniter"
-output_environment: "public_html"
-text_parser: textile
-template_parser: liquid
-style_parser: less
-script_parser: coffeescript
+output_environment: "output"
+text_parser: textile

data/lib/textigniter.rb

@@ -33,7 +33,7 @@ class Textigniter
       $config = YAML::load(File.dirname(__FILE__) + '/skeleton/config.yml')
     end
     # Store textigniter enviornment path in a global
-    $twd = Dir::pwd + "/#{$config['textigniter_environment']}"
+    $twd = Dir::pwd + "/.textigniter"
     # Store output environment path in a global
     $owd = Dir::pwd + "/#{$config['output_environment']}"
     

data/lib/textigniter/build.rb

@@ -1,10 +1,10 @@
 # The Build class searches through the textigniter enviornment
-# (Default: /.textigniter) and parses through text files, stylesheets, and 
+# (Default: /.textigniter) and parses through text files, stylesheets, and
 # javascripts with filters that correlate to the extension of the file.  The
-# parsed content is then rendered to the output directory 
+# parsed content is then rendered to the output directory
 # (Default: /public_html)
 class Textigniter::Build
-    
+
   def initialize
     # Output a start message
     STDOUT.puts "Building static content".yellow_on_black
@@ -30,27 +30,27 @@ class Textigniter::Build
     # Render scripts to file
     RenderFiles.new.render(script_items, 'js')
   end
-  
+
   # Create a build list to pass to parsers
   def build_list(format)
     # switch on format
     case format
       when 'html'
         # Create the html list
-        build_list = Dir.glob($twd + "/content/**/*.#{$config['text_parser']}")
-      
+        build_list = Dir.glob($twd + "/content/**/*")
+
       when 'styles'
         # Create the style list
-        build_list = Dir.glob($twd + "/styles/**/*.#{$config['style_parser']}")
+        build_list = Dir.glob($twd + "/styles/**/*")
 
       when 'scripts'
         # Create the script list
-        build_list = Dir.glob($twd + "/scripts/**/*.#{$config['script_parser']}")
-        
+        build_list = Dir.glob($twd + "/scripts/**/*")
+
     end
     # Return the list
-    return build_list 
-  end  
+    return build_list
+  end
 
 end
 

data/lib/textigniter/build/script_parser.rb

@@ -3,7 +3,7 @@ class Textigniter::Build::ScriptParser
   
   def process(build_list)
     # Output message
-    STDOUT.puts "Parsing ".yellow_on_black + "[#{$config['script_parser']}]".blue_on_black + " scripts ".yellow_on_black + "[OK]".green_on_black
+    STDOUT.puts "Parsing ".yellow_on_black + "[coffeescript]".blue_on_black + " scripts ".yellow_on_black + "[OK]".green_on_black
     # create array to store processed items in
     items = Array.new
     # process the build list
@@ -18,7 +18,7 @@ class Textigniter::Build::ScriptParser
       directory = File.dirname(f).sub($twd,$owd) + '/'
       @h['directory'] = directory
       # get the file name
-      @h['filename'] = File.basename(f, ".#{$config['script_parser']}")
+      @h['filename'] = File.basename(f, ".coffeescript}")
       # parse the content
       @h['output'] = parse(contents)
       # push processed item onto the array
@@ -29,17 +29,10 @@ class Textigniter::Build::ScriptParser
   end
   
   def parse(content)
-    case $config['script_parser']
-      when "coffeescript"
-        # require coffee-script gem
-        require 'coffee-script'
-        # return the output
-        return CoffeeScript.compile content
-        
-      else
-        return content
-        
-    end
+    # require coffee-script gem
+    require 'coffee-script'
+    # return the output
+    return CoffeeScript.compile content
   end
   
 end

data/lib/textigniter/build/style_parser.rb

@@ -3,7 +3,7 @@ class Textigniter::Build::StyleParser
   
   def process(build_list)
     # Output message
-    STDOUT.puts "Parsing ".yellow_on_black + "[#{$config['style_parser']}]".blue_on_black + " styles ".yellow_on_black + "[OK]".green_on_black
+    STDOUT.puts "Parsing ".yellow_on_black + "[less]".blue_on_black + " styles ".yellow_on_black + "[OK]".green_on_black
     # create array to store processed items in
     items = Array.new
     # process the build list
@@ -18,7 +18,7 @@ class Textigniter::Build::StyleParser
       directory = File.dirname(f).sub($twd,$owd) + '/'
       @h['directory'] = directory
       # get the file name
-      @h['filename'] = File.basename(f, ".#{$config['style_parser']}")
+      @h['filename'] = File.basename(f, ".less")
       # parse the content
       @h['output'] = parse(contents)
       # push processed item onto the array
@@ -29,21 +29,14 @@ class Textigniter::Build::StyleParser
   end
   
   def parse(content)
-    case $config['style_parser']
-      when "less"
-        # require less gem
-        require 'less'
-        # instantiate the parser
-        parser = Less::Parser.new
-        # parse the content
-        tree = parser.parse(content)
-        # return the output
-        return tree.to_css
-      
-      else
-        return content
-      
-    end
+    # require less gem
+    require 'less'
+    # instantiate the parser
+    parser = Less::Parser.new
+    # parse the content
+    tree = parser.parse(content)
+    # return the output
+    return tree.to_css
   end
   
 end

data/lib/textigniter/build/template_parser.rb

@@ -3,13 +3,13 @@ class Textigniter::Build::TemplateParser
   
   def process(item_list)
     # Output message
-    STDOUT.puts "Parsing ".yellow_on_black + "[#{$config['template_parser']}]".blue_on_black + " templates ".yellow_on_black + "[OK]".green_on_black
+    STDOUT.puts "Parsing ".yellow_on_black + "[liquid]".blue_on_black + " templates ".yellow_on_black + "[OK]".green_on_black
     # create an array to store processed templates
     items = Array.new
     # iterate through the item list and parse templates
     item_list.each do |item|
       # specifiy the template
-      file = File.open(Dir::pwd + '/.textigniter/layouts/' + item['template'] + '.' + $config['template_parser'], 'rb')
+      file = File.open(Dir::pwd + "/.textigniter/layouts/" + item['template'] + '.liquid', 'rb')
       # load the template
       template_from_file = file.read
       # render the output
@@ -22,26 +22,13 @@ class Textigniter::Build::TemplateParser
   end
   
   def parse(content, item)
-    case $config['template_parser']
-      when "liquid"
-        require 'liquid'
-        #parse the template
-        template = Liquid::Template.parse(content)
-        # render the template
-        output = template.render(item)
-        # return the output
-        return output
-        
-      else
-        require 'liquid'
-        #parse the template
-        template = Liquid::Template.parse(content)
-        # render the template
-        output = template.render(item)
-        # return the output
-        return output
-        
-    end
+    require 'liquid'
+    #parse the template
+    template = Liquid::Template.parse(content)
+    # render the template
+    output = template.render(item)
+    # return the output
+    return output
   end
   
 end

data/lib/textigniter/build/text_parser.rb

@@ -22,14 +22,18 @@ class Textigniter::Build::TextParser
       meta.each do |m|
         @h[m[0]] = m[1]
       end
+      # add config to the mix
+      $config.each do |c|
+        @h[c[0]] = c[1]
+      end
       # get the slug if it exists else calculate
       unless @h.has_key? 'slug'
         @h['slug'] = File.basename(f, '.textile')
       end
       # the write directory
       directory = File.dirname(f).sub($twd,$owd) + '/' + @h['slug']
-      directory = directory.sub('public_html/content', 'public_html')
-      directory = directory.sub('public_html/index', 'public_html') + '/'
+      directory = directory.sub("#{$config['output_environment']}/content", "#{$config['output_environment']}")
+      directory = directory.sub("#{$config['output_environment']}/index", "#{$config['output_environment']}") + '/'
       @h['directory'] = directory
       # get the template if exists else default
       unless @h.has_key? 'template'
@@ -58,6 +62,16 @@ class Textigniter::Build::TextParser
         require 'RedCloth'
         return RedCloth.new(content).to_html
     
+      when "markdown"
+        require 'kramdown'
+        return Kramdown::Document.new(content).to_html
+      
+      when "html"
+        return content
+      
+      when "txt"
+        return content
+            
       else
         require 'RedCloth'
         return RedCloth.new(content).to_html

data/lib/textigniter/scrub.rb

@@ -21,7 +21,7 @@ class Textigniter::Scrub
     cwd = Dir::pwd + '/'
     # Scrub the directory, no turning back
     scrub_directory(cwd + '.textigniter')
-    scrub_directory(cwd + 'public_html')
+    scrub_directory(cwd + "#{$config['output_environment']}")
     # Files to delete as well
     files = [ cwd + "README.textile", cwd + "config.yml" ]
     # Remove files specified

data/textigniter.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
   s.rubygems_version        = '1.9.2'
 
   s.name                    = 'textigniter'
-  s.version                 = '0.0.3'
+  s.version                 = '0.0.31'
   s.executables             << 'textigniter'
   s.date                    = '2011-11-19'
   
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files        = %w[README.textile LICENSE]
   
   s.add_dependency('RedCloth', '>= 0')
+  s.add_dependency('kramdown', '>= 0')
   s.add_dependency('liquid', '>= 0')
   s.add_dependency('less', '>= 0')
   s.add_dependency('coffee-script', '>= 0')
@@ -38,12 +39,9 @@ Gem::Specification.new do |s|
     lib/skeleton/.textigniter/content/about.textile
     lib/skeleton/.textigniter/scripts/functions.coffeescript
     lib/skeleton/.textigniter/styles/style.less
+    lib/skeleton/.textigniter/layouts/about.liquid
     lib/skeleton/.textigniter/layouts/default.liquid
     lib/skeleton/.textigniter/layouts/partials
-    lib/skeleton/public_html/media/README.textile
-    lib/skeleton/public_html/media/images/README.textile
-    lib/skeleton/public_html/scripts/README.textile
-    lib/skeleton/public_html/styles/README.textile
     lib/textigniter.rb
     lib/textigniter/build.rb
     lib/textigniter/help.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textigniter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.31
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &70166844060160 !ruby/object:Gem::Requirement
+  requirement: &70121931208660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70166844060160
+  version_requirements: *70121931208660
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: &70121931208140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121931208140
 - !ruby/object:Gem::Dependency
   name: liquid
-  requirement: &70166844059620 !ruby/object:Gem::Requirement
+  requirement: &70121931207600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70166844059620
+  version_requirements: *70121931207600
 - !ruby/object:Gem::Dependency
   name: less
-  requirement: &70166844059060 !ruby/object:Gem::Requirement
+  requirement: &70121931207100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70166844059060
+  version_requirements: *70121931207100
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &70166844058580 !ruby/object:Gem::Requirement
+  requirement: &70121931206500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70166844058580
+  version_requirements: *70121931206500
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &70166844058020 !ruby/object:Gem::Requirement
+  requirement: &70121931205820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70166844058020
+  version_requirements: *70121931205820
 description: ! "    Textigniter is a lightweight static site generator based on\n
   \   textile, liquid, less, and coffeescript. Future versions may\n    be more modular
   but let's be honest, I'm pretty partial to\n    textile.\n"
@@ -87,11 +98,8 @@ files:
 - lib/skeleton/.textigniter/content/about.textile
 - lib/skeleton/.textigniter/scripts/functions.coffeescript
 - lib/skeleton/.textigniter/styles/style.less
+- lib/skeleton/.textigniter/layouts/about.liquid
 - lib/skeleton/.textigniter/layouts/default.liquid
-- lib/skeleton/public_html/media/README.textile
-- lib/skeleton/public_html/media/images/README.textile
-- lib/skeleton/public_html/scripts/README.textile
-- lib/skeleton/public_html/styles/README.textile
 - lib/textigniter.rb
 - lib/textigniter/build.rb
 - lib/textigniter/help.rb