-
Notifications
You must be signed in to change notification settings - Fork 0
Home
home | rdocs | discuss | source
Developers! Be sure to check out WebMe’s Development Bounties.
WebMe converts a README file, in either RDoc or Markdown format, into a simple website.
WebMe’s output is fairly nice and can serve as a final site design if one chooses. And there are a number or templates to choose from. However, WebMe is probably more useful in giving the developer a starter site upon which to create a unique and even nicer looking site, once a project’s README document is mature.
WebMe tries to gather as much information about a project as it can from the README file, but because it would be impractical to teach WebMe to actually comprehend a README file, it must garner information about a project from elsewhere. For this, WebME relies on Ruby POM. While WebMe can work without POM entries, for optimal rendition you will want add as complete a set of meta/ (or .meta/) entries to your project as possible. See http://wiki.github.com/proutils/pom for additional information.
After that, usage is very easy. Many defaults settings are built into the system. So a simple:
$ webme
from the root of a project is enough to produce a site. By default WebMe looks for either site/, web/, or website/ directories to place its generated files. If none of these is found it will create a site/ directory for the purpose. To use an alternate location supply the —output or -o option. Eg.
$ webme -o html/
If the output directory already exists, webme will ask you to provide the —force option to confirm that it is okay to overwrite any files within that directory.
WebMe comes bundled with a number of different templates. You can get a list of these templates with the —list option.
$ webme --list
Specify the template you’d like to use with the —template or -t option.
$ webme -t joy
If WebMe finds a webme/options.yml file in the project’s config/ or .config/ directory, or the users $HOME/.config directory, it will load it and use the settings specified there. This can be very useful in the early period of a project’s development, as it allows for the adjustment of the look of a site and repeat the same settings as the project’s README improves.
All built-in templates use a common layout of:
assets/
images/
includes/
scripts/
styles/
index.html
While this layout is not strictly neccessary, it’s a useful convention.
If WebMe finds an assets/includes/advert.html file, some templates will incorporate that into the site.
Also, if WebMe finds a assets/images/logo.* file, some templates will try to incorporate it into the site. The logo image can be a png, gif or jpg. If the logo file is not found the template may attempt to find a suitable candidate on the Internet (via Yahoo Search API) and save it. Note this feature requires BOSSman (http://github.com/bossman) and a Yahoo Application ID stored in .config/webme/yahoo.id (or alike config directory as mentioned above).
By the way, this website is generated using WebMe, without any additional augmentation.
To install with RubyGems simply open a console and type:
$ gem install webme
To do a site install you will need Setup.rb, then download the tar.gz package and type:
$ tar -xvzf webme-0.3.tgz $ cd webme-0.3.tgz $ sudo setup.rb
Copyright © 2009 Thomas Sawyer
This program is distributed under the terms of the GPL license.
Please see COPYING file.