1
0
mirror of https://github.com/kremalicious/blog.git synced 2024-11-25 11:18:35 +01:00
blog/README.md

77 lines
2.3 KiB
Markdown
Raw Normal View History

2013-11-21 00:54:28 +01:00
kremalicious3
2013-11-30 17:13:19 +01:00
==================
2013-11-20 23:33:58 +01:00
> [kremalicious.com](http://kremalicious.com) based on [Jekyll](http://jekyllrb.com). Neat.
2013-12-04 23:52:22 +01:00
2016-04-24 01:47:18 +02:00
[![Build Status](https://travis-ci.org/kremalicious/kremalicious3.svg?branch=master)](https://travis-ci.org/kremalicious/kremalicious3)
2017-09-09 14:40:43 +02:00
[![Dependency Status](https://gemnasium.com/kremalicious/kremalicious3.svg)](https://gemnasium.com/kremalicious/kremalicious3)
2017-07-22 23:57:55 +02:00
[![Greenkeeper badge](https://badges.greenkeeper.io/kremalicious/kremalicious3.svg)](https://greenkeeper.io/)
2014-08-10 15:30:06 +02:00
2014-07-03 19:38:00 +02:00
2013-11-20 23:33:58 +01:00
Requirements
------------------
2013-12-08 15:33:16 +01:00
You need to have the following tools installed on your development machine before moving on:
- [node.js](http://nodejs.org/) & [npm](https://npmjs.org/)
- [Ruby](https://www.ruby-lang.org) (for sanity, install with [rvm](https://rvm.io/)) and [Bundler](http://bundler.io/)
2013-11-30 04:03:48 +01:00
2015-05-25 22:31:28 +02:00
Content Creation
------------------
Some handy rake tasks creating the correct front matter for each content type:
New Content | Command
----------- | -----------
Post | `rake post -- Title`
Photo | `rake photo -- Title`
Link | `rake link -- Title`
2013-11-30 17:13:19 +01:00
Get up and running
------------------
2013-11-30 04:03:48 +01:00
2013-12-08 15:33:16 +01:00
### Install dependencies
Run the following command from the repository's root folder to install all dependencies.
2014-07-03 19:38:00 +02:00
```bash
2017-05-28 22:06:41 +02:00
npm install && bundle install
2013-12-04 23:52:22 +01:00
```
2013-11-30 04:03:48 +01:00
2015-08-30 14:02:02 +02:00
### Development server
2013-12-08 15:33:16 +01:00
2015-08-30 15:05:08 +02:00
This generates the site with the dev build task `gulp build` and starts a local dev server combined with a livereloading watch task under `http://localhost:1337`.
2013-12-08 15:33:16 +01:00
2013-12-04 23:52:22 +01:00
```bash
gulp
2013-12-04 23:52:22 +01:00
```
2013-11-30 17:13:19 +01:00
2013-12-08 15:33:16 +01:00
### Production build
2013-12-04 23:52:22 +01:00
```bash
2015-08-30 14:02:02 +02:00
gulp build --production
2013-12-04 23:52:22 +01:00
```
2014-08-10 14:50:44 +02:00
Licenses
------------------
### Posts
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/80x15.png" /></a><br />All post content under `_src/_posts` is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
### Photos & images
All photos & image assets under `_src/_media`, `_src/assets/img`, and `assets sheet.psd` are plain ol' copyright.
2017-09-09 14:40:43 +02:00
Copyright (c) 20082017 Matthias Kretschmann
2014-08-10 14:50:44 +02:00
Don't care if you fork & play with it, but you're not allowed to publish anything from it as a whole without my written permission.
### Everything else
The MIT License (MIT)