mirror of
https://github.com/kremalicious/blog.git
synced 2024-11-29 23:48:11 +01:00
97 lines
3.3 KiB
Markdown
97 lines
3.3 KiB
Markdown
kremalicious3
|
||
==================
|
||
|
||
> [kremalicious.com](http://kremalicious.com) based on [Jekyll](http://jekyllrb.com). Neat.
|
||
|
||
[![Build Status](https://travis-ci.org/kremalicious/kremalicious3.svg?branch=master)](https://travis-ci.org/kremalicious/kremalicious3)
|
||
[![Dependency Status](https://gemnasium.com/kremalicious/kremalicious3.svg)](https://gemnasium.com/kremalicious/kremalicious3)
|
||
|
||
|
||
Requirements
|
||
------------------
|
||
|
||
You need to have the following tools installed on your development machine before moving on:
|
||
|
||
- [node.js](http://nodejs.org/) & [npm](https://npmjs.org/)
|
||
- [Bower](http://bower.io/)
|
||
- [Ruby](https://www.ruby-lang.org) (for sanity, install with [rvm](https://rvm.io/)) and [Bundler](http://bundler.io/)
|
||
|
||
|
||
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`
|
||
|
||
|
||
Get up and running
|
||
------------------
|
||
|
||
|
||
### Install dependencies
|
||
|
||
Run the following command from the repository's root folder to install all dependencies.
|
||
|
||
```bash
|
||
npm install && bower install && bundle install
|
||
```
|
||
|
||
### Development server
|
||
|
||
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`.
|
||
|
||
```bash
|
||
gulp
|
||
```
|
||
|
||
### Production build
|
||
|
||
```bash
|
||
gulp build --production
|
||
```
|
||
|
||
|
||
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.
|
||
|
||
Copyright (c) 2008–2014 Matthias Kretschmann
|
||
|
||
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)
|
||
|
||
Copyright (c) 2008–2014 Matthias Kretschmann
|
||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
of this software and associated documentation files (the "Software"), to deal
|
||
in the Software without restriction, including without limitation the rights
|
||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
copies of the Software, and to permit persons to whom the Software is
|
||
furnished to do so, subject to the following conditions:
|
||
|
||
The above copyright notice and this permission notice shall be included in
|
||
all copies or substantial portions of the Software.
|
||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
THE SOFTWARE.
|