rubyworks / brite Goto Github PK

View Code? Open in Web Editor NEW

5.0 3.0 1.0 1.87 MB

Brite is "Web Write"

Home Page: http://rubyworks.github.com/brite

License: Other

Ruby 91.78% CSS 8.22%

brite's Introduction

Brite

Homepage | Documentation | Report Issue | Development | Mailing List

DESCRIPTION

Brite is an innovative static website/blog generation utility which is as easy to use as it is versatile.

FEATURES

Site layout is 100% user-defined.
Can generate files in place, so no "special directories" are required.
Or templated routes can customize the site organization.
Supports multi-format templates via Neapolitan template engine.
Which supports many markup and templating formats via Malt or Tilt.

SYNOPSIS

Very briefly, one creates .page, .post, .part and .layout files and then runs:

$ brite

Voila, website made!

Of course, the question really is: how does one go about creating .page, .post, .part, and .layout files and such. For information about that see the Brite website and see the Getting Started Tutorial.

For a quick start, have a look at the brite-site repository, which contains a generic Brite project anyone can use to start their own Brite Site.

To get further under the hood, see Brite source code in the GitHub hosted repository and read the API documentation.

HOW TO INSTALL

RubyGems

$ gem install brite

Setup.rb

If you are old fashioned and want to install to a site location, see Setup.rb.

COPYRIGHTS

Brite is distributable in accordance with the BSD-2-Clause license.

See LICENSE.md file for details.

brite's People

Contributors

Stargazers

Watchers

Forkers

apotheon

brite's Issues

MathML Plugin

Consider MathML plug-in for future version.

running "brite",met error,how to fix it?

hi.

as3:/brite-site# brite
/usr/local/ruby/lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45:in require': cannot load such file -- facets/hash/rekey (LoadError) from /usr/local/ruby/lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45:inrequire'
from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/neapolitan-0.4.1/lib/neapolitan/core_ext.rb:1:in <top (required)>' from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/neapolitan-0.4.1/lib/neapolitan.rb:5:inrequire_relative'
from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/neapolitan-0.4.1/lib/neapolitan.rb:5:in <module:Neapolitan>' from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/neapolitan-0.4.1/lib/neapolitan.rb:1:in<top (required)>'
from /usr/local/ruby/lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45:in require' from /usr/local/ruby/lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45:inrequire'
from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/brite-0.7.0/lib/brite/controller.rb:1:in <top (required)>' from /usr/local/ruby/lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45:inrequire'
from /usr/local/ruby/lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45:in require' from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/brite-0.7.0/lib/brite.rb:10:in<top (required)>'
from /usr/local/ruby/lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45:in require' from /usr/local/ruby/lib/ruby/2.0.0/rubygems/core_ext/kernel_require.rb:45:inrequire'
from /usr/local/ruby/lib/ruby/gems/2.0.0/gems/brite-0.7.0/bin/brite:2:in <top (required)>' from /usr/local/ruby/bin/brite:23:inload'
from /usr/local/ruby/bin/brite:23:in `

'
as3:/brite-site#

tks a lot

Require Backend Engines on Demand

Require backend engines only when used. Currently all are required when brite is executed.

Rack server w/o generation

Ultimately I want to be able to serve Brite sites via the rack server without having to generate the site on disk. Currently the rack server provided simply serves up a disk location, so generating the site first is necessary.

This feature would allow brite sites to be served by rack-capable hosting services (like Heroku) very easily.

Summary Truncation

Need to improve truncation of summaries. This is tricky for brite because it allows multiple formats per-document, so word counts aren't easily calculated with accuracy.

One alternative I noticed by another blog engine was to use a marker (eg. '~~') to indicate the cut-off point. This is nice b/c it allows the writer to decide where the summary cut-off should be.

Note we can also offer a summary field in the YAML front matter that would be used instead if present.

Sass support

Consider adding Sass support in the future. (http://sass-lang.com/)

Pagination Support

Need to add pagination support for blogging. Once could of course manually add pages that covered only a given period or number of posts, but it would be nice if this could be done automatically somehow.

Pagination can be a challenge for a static site, since each page must be a separate file. I think it would be best to keep the design highly structured around time periods. We could offer an option to paginate on a monthly or yearly basis (default to yearly), and set which page to be paginated. This would create multiple paged for the same template page, but each having the different set of posts.

Support for .style files?

Perhaps it would be best if Brite had support for an additional.style type of file, instead of overloading .page which is now used for creation of stylesheets.

Acquisition Support

Maybe it would be useful to add acquisition support akin to Zope.