Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improve README

- Remove odd sentence strucure
- Simplify links
  • Loading branch information...
commit 0fef2dcd51bcdd8137b981fbdeaaa6214e5cdbaf 1 parent 14a5394
@pvorb authored
Showing with 40 additions and 40 deletions.
  1. +40 −40 README.mkd
View
80 README.mkd
@@ -1,10 +1,10 @@
# bake
-a template engine for static text files. It is something like
-[Tom Preston-Werner][mojombo]'s [jekyll][jekyll], but is independent of file
+bake is a template engine for static text files. It is something like
+[Tom Preston-Werner][mojombo]'s [jekyll], but it is independent of file
types and markup languages.
-bake allows you to apply JavaScript templates to any type of text files. These
+It allows you to apply JavaScript templates to any type of text file. These
templates are written in [embedded JavaScript][ejs].
## Installation
@@ -20,20 +20,19 @@ A template (`default.tpl`) may look like this:
```html
<!DOCTYPE html>
<html lang="<%= lang %>">
-<head>
- <meta charset="utf-8">
- <title><%= title %> | <%= siteTitle %></title>
-</head>
-<body>
- <h1><%= title %></h1>
+ <head>
+ <meta charset="utf-8">
+ <title><%- title %> | <%= siteTitle %></title>
+ </head>
+ <body>
+ <h1><%- title %></h1>
-<%= __content %>
+ <%- __content %>
<% if (locals.foo) { %>
- <p>Foo is defined.</p>
+ <p>Foo is defined.</p>
<% } %>
-
-</body>
+ </body>
</html>
```
@@ -51,12 +50,12 @@ With a minimal configuration object
```javascript
{
- "fileExtensions": {
- "txt": "html" // look for html files and save as html file
- },
- "properties": {
- "siteTitle": "My Site" // Global website title
- }
+ "fileExtensions": {
+ "txt": "html" // look for html files and save as html file
+ },
+ "properties": {
+ "siteTitle": "My Site" // Global website title
+ }
}
```
@@ -65,38 +64,38 @@ the output (`post.html`) would be:
```html
<!DOCTYPE>
<html lang="en">
-<head>
- <meta charset="utf-8">
- <title>A sample file | My Site</title>
-</head>
-<body>
- <h1>A sample file</h1>
-
-<p>Sample text.</p>
+ <head>
+ <meta charset="utf-8">
+ <title>A sample file | My Site</title>
+ </head>
+ <body>
+ <h1>A sample file</h1>
+
+ <p>Sample text.</p>
-
-</body>
+ </body>
</html>
```
-**bake** not only enables building websites (although that's its main purpose)
+bake not only enables building websites (although thats its main purpose)
but lets you choose. You can write hooks for each property to control the
output.
-Visit the [Wiki][wiki] for more information or look at the [example][example].
+Visit the [Wiki] for more information or look at the [example].
## What this is not
-**bake** is not a webserver. It doesn't replace your Apache/Nginx etc. So if you
-want to write a website that is accessible by the public, you have to change the
-settings of your webserver to use `bakeDir` as the root directory.
+bake is **not a webserver** nor comes with one. It doesn't replace your
+Apache/Nginx etc. So if you want to write a website that is accessible by the
+public, you have to change the settings of your webserver to use `bakeDir` as
+the root directory.
-**bake** is no blogging engine (although it's possible to create one with the
-help of **bake**). It doesn't provide generating an index or a feed. It doesn't
+bake is **no blogging engine** (although it's possible to create one with the
+help of bake). It doesn't provide generating an index or a feed. It doesn't
have any commenting functionality either. If you are looking for a system with
-these features, try [bread][bread] which is based on **bake**.
+these features, try [bread] which is based on bake.
## Bugs and Issues
@@ -107,9 +106,9 @@ If you encounter any bugs or issues, feel free to open an issue at
## Credits
-This work was inspired by [heimweh][heimweh] by [Benjamin Birkenhake][ben_] and
-[txtracer][txtracer] by [Konstantin Weiss][konnexus], but also by
-[wheat][wheat] by [Tim Caswell][creationix] and [jekyll][jekyll] by [Tom
+This work was inspired by [heimweh] by [Benjamin Birkenhake][ben_] and
+[txtracer] by [Konstantin Weiss][konnexus], but also by
+[wheat] by [Tim Caswell][creationix] and [jekyll] by [Tom
Preston-Werner][mojombo].
[jekyll]: http://jekyllrb.com/
@@ -130,6 +129,7 @@ Preston-Werner][mojombo].
[creationix]: //github.com/creationix
[mojombo]: http://tom.preston-werner.com/
+
## License
Copyright © 2011-2012 Paul Vorbach
Please sign in to comment.
Something went wrong with that request. Please try again.