Git Product home page Git Product logo

postview's Introduction

Postview - A lightweight blog engine

Postview is a simple blog engine (a.k.a. blogware) written in Ruby using the Sinatra framework and Kramdown parser to renders files written in Markdown.

Features

  • Easy configuration.
  • Easy synchronization.
  • No database, it's use only text files written in Markdown.
  • Has suport to themes.

Getting started

Install Ruby [Gem package][postview gem] and try.

The Postview depended of the following libraries (Gems):

Install stable gem from RubyForge or [GemCutter.org][].

$ sudo gem install postview

Then, run command for create and setup a new Postview directory structure.

$ postview create path/to/blog

Or run using "--prompt-values":

$ postview create path/to/blog --prompt-values

After setup, run server with command:

$ postview server

In your browser, access http://127.0.0.1:9000/.

How it works

The Postview creates a directory structure like this:

.
|-- config
|-- posts
|   |-- archive
|   `-- drafts
|-- public
|-- themes
|   `-- default
|       |-- images
|       |-- stylesheets
|       `-- templates
|           |-- archive
|           |-- drafts
|           |-- posts
|           `-- tags
`-- tmp

Create new post

New post can be created by using the task post:

$ cd path/to/postview
$ rake post

Following all instructions. Please, set environment variable +EDITOR+ or +VISUAL+ for editing your posts. Other else, run:

$ cd path/to/postview
$ EDITOR=<your-favorite-editor> rake post

The new post will be written in drafts directory. You can pass other directory.

$ cd path/to/postview
$ rake post[path/to/other/post/directory]

NOTE: New feature for creates new post from blog manager will be added.

Synchronize your posts

Postview use by default FTP method for synchronization. But, is possible make deploy using Heroku and Git.

FTP

You can synchronize your files using the . For more information about this task, run rake -D sync.

It's need creates and edit file placed in /your/home/directory/.netrc. The directory attribute most be setted in settings.yml file.

Example:

# remote host
/remote/path/to/postview
`-- posts
    |-- archive
    `-- drafts
# local host
posts
|-- 20090702-foo_post_article.ruby.sinatra.git.mkd
|-- archive
|   `-- 20080702-foo_post_article.ruby.sinatra.git.mkd
`-- drafts
    `-- 20090703-foo_draft_article.ruby.sinatra.git.mkd

# To synchronize posts
$ rake sync:posts
$ rake sync:posts[remote/path/to/postview/posts]

# To synchronize archive
$ rake sync:archive
$ rake sync:archive[remote/path/to/postview/posts/archive]

# To synchronize drafts
$ rake sync:drafts
$ rake sync:drafts[remote/path/to/postview/posts/drafts]

# To synchronize all
$ rake sync:all

NOTE: Will added new enhancements for this feature.

postview's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.