Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 37 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,54 @@
# Blossome

Blossome is a hacker blog. As opposed to other blog engines, this was is
intended to be modified/hacked.

It's built on:
Sinatra + haml + sass with posts written in Markdown with some help from
Mustache.

- [Sinatra][1]
- [HAML][2]
- [SASS][3]
- Written in [Markdown][4]
- With help from [Mustache][5]

[1]: http://www.sinatrarb.com/
[2]: http://haml.info/
[3]: http://sass-lang.com/
[4]: http://daringfireball.net/projects/markdown/
[5]: https://mustache.github.io/

## Getting Started

1. Clone the whole repository
- git clone https://github.com/danpal/blossome
```shell
$ git clone https://github.com/danpal/blossome
```

2. Install all dependencies
- cd blossome
- bundle install
```shell
$ cd blossome
$ bundle install
```

3. Start the server
- shotgun config.ru
4. Open chrome
- go to: 127.0.0.1:9393
```shell
$ shotgun config.ru
```
4. Open your favorite web browser and go to <http://127.0.0.1:9393>

## Writing posts

Post go in the /posts folder. They are written with markdown, here's the
Post go in the `/posts` folder. They are written with Markdown, here's the
rules:

1. The name of the file is the route. So foo-bar.md is accessible at
/foo-bar

2. Filenames have to end with .md
1. The name of the file is the route. So `foo-bar.md` is accessible at
`/foo-bar`

3. At the top include a description in between "-----" Eg:


<pre><code>
-----------------------
title: "Title of the post"
description: "this goes on the SEO description"
keywords: "some, SEO, keywords"
date: October 31, 2012
-----------------------
</code></pre>
2. Filenames have to end with `.md`

3. At the top include a description in between `-----` Eg:
```yaml
-----------------------
title: "Title of the post"
description: "this goes on the SEO description"
keywords: "some, SEO, keywords"
date: October 31, 2012
-----------------------
```
4. Date format is Month day, year. Full name on months.