RubyGems - clay - Versions diffs - 1.3 → 1.4 - Mend

clay 1.3 → 1.4

Files changed (3) hide show

data/README.md ADDED

@@ -0,0 +1,74 @@
+## About
+Clay generates static pages using layouts and text snippets. It is something like a CMS for those who know html and would like to use their own text editor. Clay was inspired by [jekyll](http://jekyllrb.com/) which is a simple tool to create a blog. The difference between clay and jekyll is that clay aims at a clear folder structure and simple templating using [mustache](http://mustache.github.com/).
+There are plans for adding a blogging support in clay too.
+## Getting started
+* Start by installing the [gem](https://rubygems.org/gems/clay)
+        gem install clay
+* Init your project using clay
+        clay init <project name>
+* Create layouts/default.html in the project directory with the following content:
+        <html>
+          <title>{{title}}</title>
+          <body>{{{content}}}</body>
+        </html>
+* Create pages/index.html in the project directory
+        ---
+        title: Home
+        ---
+        <h1>Hello from clay</h1>
+* run
+        clay form && clay run
+* Preview Your site on http://localhost:9292 or publish it via FTP.
+  When publishing, You should take only the files in the build folder
+## Howto
+In your project directory You will find following subdirectories
+* layouts
+* pages
+* public
+The _layouts_ directory is for the global layouts of your pages.
+There must be a layout called default.html
+In the _pages_ directory You create each page You want to have.
+The pages are created in html or markdown.
+The filename of an html page must be <pagename>.html
+Markdown pages however can be either <pagename>.md or <pagename>.markdown
+*NOTE* Your pages may have any names You want. However given your domain
+name is foo.com, and You want that the main page shows up at http://foo.com
+You will have to create page named index in the pages directory
+----------------------------------------
+## Licence
+[Clay](https://github.com/kerestey/clay) by [Pavlo Kerestey](http://kerestey.net) is licensed under a [MIT Licence](http://creativecommons.org/licenses/MIT/). Permissions beyond the scope of this license may be available at <a xmlns:cc="http://creativecommons.org/ns#" href="http://kerestey.net" rel="cc:morePermissions">http://kerestey.net</a>.
+## Full text of the licence
+    Copyright (C) 2011 by Pavlo Kerestey
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    THE SOFTWARE.

data/src/clay.rb CHANGED

@@ -1,12 +1,12 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'mustache'
-require 'rdiscount'
+require 'bluecloth'
 require 'fileutils'
 require 'yaml'
 module Clay
-  VERSION = "1.3"
+  VERSION = "1.4"
   def self.init project_name
     puts "Creating the folder structure... "
@@ -175,7 +175,7 @@ private
   def parsed_content content, data
     case @page_type
-    when "markdown" then return Mustache.render(RDiscount.new(content).to_html.strip, data)
+    when "markdown" then return Mustache.render(BlueCloth.new(content).to_html.strip, data)
     when "html" then return Mustache.render(content, data)
     end
   end
@@ -209,6 +209,6 @@ class Text
 private
   def parse content
-    RDiscount.new(content).to_html.strip
+    BlueCloth.new(content).to_html.strip
   end
 end

metadata CHANGED

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: clay
 version: !ruby/object:Gem::Version
-  hash: 9
+  hash: 7
   prerelease: false
   segments:
   - 1
-  - 3
-  version: "1.3"
+  - 4
+  version: "1.4"
 platform: ruby
 authors:
 - Pavlo Kerestey
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-01-02 00:00:00 +01:00
+date: 2011-01-03 00:00:00 +01:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -23,27 +23,28 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        hash: 29
+        hash: 3
         segments:
         - 0
-        - 11
-        version: "0.11"
+        version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency
-  name: rdiscount
+  name: bluecloth
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        hash: 3
+        hash: 29
         segments:
+        - 2
         - 0
-        version: "0"
+        - 9
+        version: 2.0.9
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency
@@ -60,25 +61,10 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency
-  name: bundler
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        hash: 15
-        segments:
-        - 1
-        - 0
-        version: "1.0"
-  type: :development
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency
   name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ">="
@@ -88,11 +74,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency
   name: rake
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ">="
@@ -102,19 +88,20 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
-description: A sticky clay to automatically form a static website using Mustache templates and markdown files.
+  version_requirements: *id005
+description: A lightweight CMS to form a static website with layouts, files and text snippets.
 email:
 - pavlo@kerestey.net
 executables:
 - clay
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - src/clay.rb
 - src/rack/clay.rb
+- README.md
 - bin/clay
 has_rdoc: true
 homepage: http://kerestey.net/clay
@@ -151,6 +138,6 @@ rubyforge_project: clay
 rubygems_version: 1.3.7
 signing_key:
 specification_version: 3
-summary: A sticky clay to automatically form a static website.
+summary: A very lightweight CMS to automatically form a static website.
 test_files: []