https://github.com/rubyworks/brite
Brite is "Web Write"
https://github.com/rubyworks/brite
Last synced: 6 months ago
JSON representation
Brite is "Web Write"
- Host: GitHub
- URL: https://github.com/rubyworks/brite
- Owner: rubyworks
- License: other
- Created: 2009-08-25T21:17:26.000Z (over 16 years ago)
- Default Branch: master
- Last Pushed: 2014-04-09T02:01:59.000Z (almost 12 years ago)
- Last Synced: 2023-04-10T08:21:02.251Z (almost 3 years ago)
- Language: Ruby
- Homepage: http://rubyworks.github.com/brite
- Size: 1.83 MB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Brite
[Homepage](http://rubyworks.github.com/brite) |
[Documentation](http://rubydoc.info/gems/brite/frames) |
[Report Issue](http://github.com/rubyworks/brite/issues) |
[Development](http://github.com/rubyworks/brite) |
[Mailing List](http://groups.google.com/group/rubyworks-mailinglist)
[](http://travis-ci.org/rubyworks/brite)
## 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](https://rubyworks.github.com/brite) and see the
[Getting Started Tutorial](https://github.com/rubyworks/brite/wiki/Getting-Started).
For a quick start, have a look at the [brite-site repository](https://github.com/rubyworks/brite-site),
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](http://github.com/rubyworks/brite)
and read the [API documentation](http://rubydoc.info/gems/brite/frames).
## 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](http://rubyworks.github.com/setup).
## COPYRIGHTS
Copyright (c) 2009 Rubyworks
Brite is distributable in accordance with the *BSD-2-Clause* license.
See LICENSE.md file for details.