Code Monkey home page Code Monkey logo

grunt-jekyll's Introduction

grunt-jekyll

Straightforward grunt.js Jekyll plugin. The code base is inspred by grunt-compass. This means its use is similar but outlined in detail here.

Dependencies

You need to have node.js, grunt.js, Ruby and Jekyll installed for this to work.

Quick Start

Follow this grunt.js example to get started with grunt-jekyll right away.

Installation & Options

Installation

Install this grunt plugin next to your project's grunt.js gruntfile with:

npm install grunt-jekyll

Configuration Options

All the configuration options are

  • on the Jekyll Wiki.
  • optional
  • explained here within the grunt.js task object context:
Object Property Type Default Value Notes
src
[path]
"."
Source Path
dest
[path]
"./site"
Destination Path
safe
[bool]
false
Disables custom plugins.
auto
[bool]
false
Jekyll watches src path for changes.
server
[bool]
false
Jekyll Server
server_port
[int]
undefined
Server Port
baseurl
[url]
undefined
Serve from URL
url
[url]
undefined
Sets site.url
markdown
[engine]
undefined
Markdown Engine
pygments
[bool]
false
Syntax Highlighting
future
[bool]
false
Publish Future Posts
lsi
[bool]
false
Related Posts Index
permalink
[style]
undefined
Permalink Style
paginate
[int]
undefined
Per-page Pagination
limit_posts
[int]
undefined
Max Posts

Changelog

v0.2.1: Fixed destination path option.

v0.2.0: Updated README with better options. Options are more flexible.

v0.1.6: Updated README with better example.

v0.1.0: Initial Release.

MIT License

grunt-jekyll is freely distributable under the terms of the MIT license.

Copyright (c) 2012, Danny Garcia. All rights reserved.

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.

grunt-jekyll's People

Contributors

dannygarcia avatar

Watchers

James Cloos avatar

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.