twp/webby

NO LONGER UNDER DEVELOPMENT

NO LONGER UNDER ACTIVE DEVELOPMENT¶ ↑

Webby is no longer under active development. If you would like to take over the project, please contact me via the GitHub message and notification system.

For similar functionality, please look into the nanoc project of Denis Defreyne.

Webby¶ ↑

• Homepage

• Rubyforge Project

• email tim dot pease at gmail dot com

DESCRIPTION:¶ ↑

Webby is a fantastic little website management system. It would be called a *content management system* if it were a bigger kid. But, it’s just a runt with a special knack for transforming text. And that’s really all it does - manages the legwork of turning text into something else, an *ASCII Alchemist* if you will.

Webby works by combining the contents of a page with a layout to produce HTML. The layout contains everything common to all the pages - HTML headers, navigation menu, footer, etc. - and the page contains just the information for that page. You can use your favorite markup language to write your pages; Webby supports quite a few.

Install Webby and try it out!

FEATURES:¶ ↑

• choose your templating language: ERB, Textile, Markdown, HAML, SASS

• support for UltraViolet and CodeRay syntax highlighting

• embeddable DOT scripts for Graphviz graphs

• LaTeX snippets for mathematical formulas

• automatically clean up generated content using Tidy

• quick and speedy - only builds pages that have changed

• deploy anywhere - it’s just HTML, no special server stuff required

• happy Rake tasks for deploying your website to a server

• build new pages from templates for quicker blog posts and news items

But Wait! There’s More!

Webby has a great autobuild feature that continuously generates HTML whenever the pages or layouts change. The HTML is served up via WebBrick, a simple webserver that comes with Ruby. Whenever you change a page, you can immediately see those changes without having to run any commands.

$ webby autobuild
[10:21:26]  INFO: starting autobuild (Ctrl-C to stop)
[10:21:26]  INFO: creating output/index.html
[10:22:57]  INFO: creating output/index.html

Webby is not limited to producing HTML. By no means! Do you ever get tired of repeating the same color code #D3C4A2 in your CSS files? Webby can help. Need some customized JavaScript for your website. Webby can help. Anytime you find yourself repeating the same bit of text over and over, then you should be using Webby.

INSTALL:¶ ↑

gem install webby

EXAMPLE:¶ ↑

$ webby-gen website my_site
creating my_site

$ cd my_site

$ webby create:page 'new page'
creating content/new-page.txt

$ webby create:page 'another/new page'
creating content/another/new-page.txt

$ webby autobuild
[10:21:26]  INFO: starting autobuild (Ctrl-C to stop)
[10:21:26]  INFO: creating output/index.html
[10:21:26]  INFO: creating output/new-page.html
[10:21:26]  INFO: creating output/another/new-page.html

REQUIREMENTS:¶ ↑

• directory_watcher

• hpricot

• logging

• rake

• rspec

• bones

LICENSE:¶ ↑

MIT License Copyright © 2007 - 2008

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, sub-license, 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.

webby's Issues

Including a page using the "name" attribute in an ERB filter

Hi,

I'm having trouble getting this to work - could you show an example ERB filter that would include the contents of another page.

Best Regards,

Carl

a question when creating a page

hi.

as3:/webby-site# webby create:page 'new page'
/usr/local/ruby/lib/ruby/gems/2.0.0/gems/webby-0.9.4/lib/webby/resources/resource.rb:12: warning: undefining object_id' may cause serious problems /usr/local/ruby/lib/ruby/gems/2.0.0/gems/webby-0.9.4/lib/webby/apps/main.rb:177:inblock in import_default_tasks': undefined method import' for #<Webby::Apps::Main:0xb9efd828> (NoMethodError) from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/webby-0.9.4/lib/webby/apps/main.rb:177:ineach'
from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/webby-0.9.4/lib/webby/apps/main.rb:177:in import_default_tasks' from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/webby-0.9.4/lib/webby/apps/main.rb:107:ininit'
from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/webby-0.9.4/lib/webby/apps/main.rb:33:in run' from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/webby-0.9.4/lib/webby/apps/main.rb:12:inrun'
from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/webby-0.9.4/bin/webby:39:in <top (required)>' from /usr/local/ruby/bin/webby:23:inload'
from /usr/local/ruby/bin/webby:23:in `

'
as3:/webby-site#

how to fix it?

HTML5 and HAML don't work together.

Any chance of getting support for html5?

bugs include:

!!! 5 renders as <!DOCTYPE 5 SYSTEM>

%header
    .some-class

Renders as:

<header></header>
<div class="some-class"></div>

Thanks

erb rendered into haml template doesn't maintain indentation

If I've got a haml template, that is first rendered through erb to create the content that will be edited, the content doesn't maintain the indentation level across multiple lines and so will break when autobuilding.

However, when any template is rendered through a haml layout, the content is properly indented within. Can this be brought down to the templates?

https://gist.github.com/c7b45c2acfbf77bd0a13

reopening IO breaks in passenger 2.2.8/2.2.9

In the core_ext/kernel.rb file, the method cmd_available? dups and reopens STDOUT/STDERR which causes issues under passenger. I've hacked my local gem to use backticks and redirect as part of the command.

I can fork and submit a pull request if you'd like.

Partial page rendering

The "autobuild" option does not seem to re-render the parent page when the partial is updated. After updating/changing the partial, I have to make a change to and save the parent page to get the parent to display the updated partial.

e.g.

parent.txt must be edited and saved otherwise _partial.txt is not rendered into parent.txt.

Would be good to get this fixed.

Fixing encoding issue in core_ext/string.rb

When running webby-gen under Ruby 1.9.1 an invalid multibyte character in the String extensions file will potentially produce an encoding error.

webby-0.9.4/lib/webby.rb:104:in `require': gems/ruby-1.9.1-p378/gems/webby-0.9.4/lib/webby/core_ext/string.rb:15: invalid multibyte char (US-ASCII) (SyntaxError)

webby-0.9.4/lib/webby/core_ext/string.rb:15: invalid multibyte char (US-ASCII)

This can be fixed by simply specifying UTF-8 encoding throughout the string extensions file using something like…

# encoding: utf-8

Maybe this fix could be added to master?

Warning on rake 0.9.4

I had a warning on rake 0.9.4.

$ webby -T                               
WARNING: Global access to Rake DSL methods is deprecated.  Please include
    ...  Rake::DSL into classes and modules which use the Rake DSL methods.
WARNING: DSL method Webby::Apps::Main#import called at /Users/hoge/.rvm/gems/ruby-1.8.7-p352@webby/gems/webby-0.9.4/lib/webby/apps/main.rb:177:in `import_default_tasks'
WARNING: DSL method Webby::Apps::Main#import called at /Users/hoge/.rvm/gems/ruby-1.8.7-p352@webby/gems/webby-0.9.4/lib/webby/apps/main.rb:181:in `import_website_tasks'