https://github.com/madx/haze

A minimalistic blogging engine, the successor of Honk
https://github.com/madx/haze

Last synced: 3 months ago
JSON representation

A minimalistic blogging engine, the successor of Honk

• Host: GitHub
• URL: https://github.com/madx/haze
• Owner: madx
• License: mit
• Created: 2010-01-08T14:25:50.000Z (almost 15 years ago)
• Default Branch: master
• Last Pushed: 2010-08-26T14:31:53.000Z (about 14 years ago)
• Last Synced: 2024-04-16T13:06:34.183Z (7 months ago)
• Language: Ruby
• Homepage: http://github.com/madx/haze
• Size: 115 KB
• Stars: 18
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-sinatra - Haze - A minimalistic blogging engine, the successor of Honk (~200 LOC). (Blogging)

README

        
Haze

====

Haze is a minimalistic blogging engine, in the spirit of

[Honk](http://github.com/madx/honk), it's predecessor.

It has very few features compared to other blog engines. Exhaustively:

* Entries, stored in flat text files

* Tags

* An archive page that lists every entry

* An Atom feed

* Drafts

* A very simple comment system

Why so few? Well, I simply don't need more.

Haze's source code is very short (~200LOC) thus the app is light and quick.

## Requirements ##############################################################

* sinatra (tested with 0.9.4)

## Install ###################################################################

    $ git clone git://github.com/madx/haze.git

Copy the files where you want to install it, then edit `config.ru` if you

want to change the defaults. Use plain ruby to do the configuration, like

this:

    require File.join(File.dirname(__FILE__), 'lib', 'haze')

    Haze.set :title,  "Blog title"

    Haze.set :author, "Your name"

    Haze.set :domain, "http://example.com/"

    Haze.set :email,  "[email protected]"

    # Replace KEY by a sha1sum of something

    Haze.set :key,    "KEY"

    Haze.reload!

    run Haze::App

Create the folder where you will put your entries: `mkdir entries`.

Then run the app with `$ rackup -E production config.ru`.

## Source ####################################################################

Haze's Git repo is available on GitHub, which can be browsed at

 and cloned with:

    git clone git://github.com/madx/haze.git

## Usage #####################################################################

Haze entry format enforces a few conventions:

An entry is split in two parts. The first is a header and the second the entry

body. The separator is a succession of at least three `-` put on a line of their

own.

The header will be the title of your entry. Every word starting with a `#` will

create a new tag. Tags are automatically lowercase'd. You can add tags that

won't show up in the title by enclosing them in braces (`{}`).

To determine the order of entries and their URLs, you have to give a correct

name to the file they are stored into.

The format is: `[+]_.(hz/draft)`.

`` must be parseable by `Time.parse`, the handiest format to use is

probably `--`. The `+` part allows you to write

multiple entries with on single ``. Behind the scenes, it simply adds

`` seconds to the parsed date.

`` will be the name of the URL for your entry. `hz` or `draft` tells if

the file is a regular entry or a draft.

Drafts are viewable using the url `/draft/`.

Example:

    $ cat entries/2009-01-08_helloworld.hz

    A #Ruby Hello world program {#tutorial,#programming}

    ---

    
Hello world is the most common program used to demonstrate a language's

    syntax. Here is one in Ruby: 


    
puts "hello world"


* Title: A Ruby Hello world program

* Tags: ruby, tutorial, programming

* Date: 2009-01-08

* Slug: helloworld

## Syncing content ############################################################

To synchronize the blog with contents, just hit the url `/_sync_?key=`,

replacing `` with the value set in `config.ru`.

To automatically update your post as you update the files, you may use

mynyml's [watchr][1] or ttilley's [fssm][2] and integrate a script in the

`config.ru` or using an external tool such as `inotifywait`.

## Static pages ###############################################################

Haze supports static pages. Just create a `static` folder in the root directory

and put raw HTML pages in it. They will be rendered inside the layout and are

available at `/static/`.

## Issues #####################################################################

There may be a bug with the Encoding class and HAML under Ruby 1.9, something

about `Encoding.default_internal`. To fix it, add this somewhere in your

`config.ru`:

    class ::Encoding

      def self.default_internal

        "utf-8" # Or the right encoding

      end

    end

[1]: http://github.com/mynyml/watchr

[2]: http://github.com/ttiley/fssm

## License ####################################################################

Haze is published under the terms of the MIT license, you can find a copy of

that license in the `LICENSE` file