https://github.com/ben-ng/blog

Blog at http://benng.me
https://github.com/ben-ng/blog

Last synced: 21 days ago
JSON representation

Blog at http://benng.me

• Host: GitHub
• URL: https://github.com/ben-ng/blog
• Owner: ben-ng
• Created: 2013-08-02T10:20:15.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-03-12T22:10:02.000Z (over 10 years ago)
• Last Synced: 2024-04-16T01:10:10.481Z (7 months ago)
• Language: JavaScript
• Size: 7.84 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
#Scotch

###A really classy, dead simple, markdown based, blogging framework for node.js

[![Build Status](https://api.travis-ci.org/Techwraith/scotch.png)](https://travis-ci.org/Techwraith/scotch)

To try Scotch for yourself, make sure that you have node, npm, and mongodb installed (and running), then do this:

    $> npm install -g scotch-blog

    $> scotch create blog

    $> cd blog

    $> sudo scotch serve

Go to `http://0.0.0.0/dashboard/install` to install Scotch.

Your blog should be up and running on `http://localhost`

### Static Site Generation

    $> cd blog

    $> scotch generate

    

Your you should now have a 'static' directory in your blog's root directory.

Read the [deployment docs](#deployment) on how to configure static site deployment.

#### Dashboard

![Scotch's dashboard](https://dl.dropbox.com/u/7982297/scotch_screens/newdash.png)

#### Writing

 

![writing in Scotch](https://dl.dropbox.com/u/7982297/scotch_screens/newwrite.png)

#### Reading

![writing in Scotch](https://dl.dropbox.com/u/7982297/scotch_screens/newread.png)

#### Deployment

Create `config/deployment.js` and fill it with your deployment settings then run `scotch deploy` from your terminal. At the moment we support S3 and FTP deployment, with gh-pages on its way.

##### Sample S3 Settings

```js

module.exports = {

  "destination": "s3"

, "opts": {

    "bucket": ""

  , "key": ""

  , "secret": ""

  , "region": ""      //us-west-1

  }

};

```

##### Sample FTP Settings

```js

module.exports = {

  "destination": "ftp"

, "opts": {

    "host": ""          //ftp.myserver.com

  , "port":             //Default: 21

  , "username": ""

  , "password": ""

  }

};

```

#### Plugins

Plugins are installed via npm and enabled via in `app/config/environment.js`.

```

/*

* Sample app/config.environment.js

* `npm install readmore`

*/

var config = {

  port: 80,

  model: {

    defaultAdapter: 'mongo'

  },

  db: {

    mongo: {

      dbname: 'blog'

    }

  },

  plugins: {

    formatters: [

      'readmore'

    ]

  }

};

module.exports = config;

```

##### Formatters

Formatter plugins enhance the markdown language.

```js

/*

* An example formatter plugin that replaces the string "charcount" with the number

* of characters in the markdown source when viewing a post in the blog index

*/

var replacer = function (buffer) {

  //`this` in the context of a formatter plugin refers to the post model

  return buffer.replace(/charcount/, this.markdown.length);

};

/*

* You can modify either the `index` or `show` actions.

* By not exporting to exports.show, our plugin will only

* run on posts during the index action

*/

exports.index = replacer;

```

### Things to Do

If you'd like to help out, check out the [issue list](https://github.com/Techwraith/scotch/issues?state=open).