Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/laktek/punch-blog

A boilerplate to create personal blogs based on Punch
https://github.com/laktek/punch-blog

Last synced: 5 days ago
JSON representation

A boilerplate to create personal blogs based on Punch

Host: GitHub
URL: https://github.com/laktek/punch-blog
Owner: laktek
License: mit
Created: 2012-11-25T23:57:51.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2014-04-17T04:59:10.000Z (over 10 years ago)
Last Synced: 2024-08-01T12:35:48.122Z (3 months ago)
Language: JavaScript
Homepage:
Size: 374 KB
Stars: 45
Watchers: 6
Forks: 14
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT

Awesome Lists containing this project

awesome-starred - laktek/punch-blog - A boilerplate to create personal blogs based on Punch (others)

README

# Punch Blog

A boilerplate to create personal blogs based on [Punch](http://laktek.github.com/punch).

## Features

* Preview posts, as you write them.

* Easily publish to Amazon S3.

* Pretty URLs for permalinks (no .html, configurable).

* Responsive, customizable theme based on [HTML5Boilerplate](html5boilerplate.com) & [320andup framework](https://github.com/malarkey/320andup/).

* Load fonts from multiple sources with [WebFonts Loader](https://github.com/typekit/webfontloader).

* Easily configure Google Analytics, Tweet button & Disqus comments.

* Highlighting the current page link.

* Post archives by tags.

* Post archives by year, month or date.

* Write posts using GitHub flavored Markdown.

* Client-side code highlighting with Prism.js

* Published/draft states.

* Automatically minifies and bundles JavaScript/CSS.

* RSS feed

* Sitemap.xml

Also, you can use any other features available in Punch.

* Manage other pages with Punch's default content handler.

* Extend the behavior by writing your own helpers.

## How to use

You can get started quickly with [Nitrous.IO](https://www.nitrous.io/hack_button?source=embed&runtime=nodejs&repo=laktek%2Fpunch-blog&file_to_open=README). [![Hack on Nitrous.IO](https://d3o0mnbgv6k92a.cloudfront.net/assets/hack-s-v1-7475db0cf93fe5d1e29420c928ebc614.png)](https://www.nitrous.io/hack_button?source=embed&runtime=nodejs&repo=laktek%2Fpunch-blog&file_to_open=README)

* [Download](https://github.com/laktek/punch-blog/archive/master.zip) & extract the code.

* Inside the project's root directory, run `npm install`.

* Set the details of the blog in `contents/shared.json`.

* Open `config.json` and change the settings as you prefer.

* Then go inside `posts` directory and edit the file `1970-01-01-lets-start.markdown`.

* Once you have created your first post, to preview it run `punch s` and point the browser to `http://localhost:9009`.

* When you are happy with the outcome, publish your blog by running `punch p`.

## License