Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ixkaito committed Jun 5, 2016
0 parents commit 96124fe
Show file tree
Hide file tree
Showing 130 changed files with 5,140 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Apache
.htaccess
.htpasswd

# Sass
.sass-cache
*.scssc

# Sublime Text
sftp-config.json

# WordPress
wp-config.php
*.sql

# Ruby on Rails
/.bundle
/db/*.sqlite3
/db/*.sqlite3-journal
/public/uploads

# Jekyll
_site

# Node.js
node_modules/

# Logfiles and tempfiles
*.log
/log/*
!/log/.keep
/tmp

# Other unneeded files
doc/
*.swp
*~
.project
.DS_Store
.idea
.secret
31 changes: 31 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
language: node_js
node_js:
- '5'
- '4'

branches:
only:
- master

env:
global:
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true
- GITHUB_REPO: 'ixkaito/frasco'

before_install:
- rvm install 2.1

install:
- npm install
- gem install jekyll html-proofer

script:
- jekyll build
- npm test
- htmlproofer ./_site

after_success:
- if [ "$TRAVIS_PULL_REQUEST" != "false" -o "$TRAVIS_BRANCH" != "master" ]; then exit 0; fi
- git push -f -q "https://${GITHUB_TOKEN}@github.com/${GITHUB_REPO}.git" master:gh-pages > /dev/null 2>&1

sudo: false
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015-2016 the contributors of the Frasco project

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.
263 changes: 263 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,263 @@
# Frasco [![GitHub release](https://img.shields.io/github/release/ixkaito/frasco.svg)](https://github.com/ixkaito/frasco/releases) [![Build Status](https://travis-ci.org/ixkaito/frasco.svg?branch=master)](https://travis-ci.org/ixkaito/frasco) [![license](https://img.shields.io/github/license/ixkaito/frasco.svg?maxAge=2592000)](https://github.com/ixkaito/frasco/blob/master/LICENSE)

__Jekyll starter project including full setup for Gulp, Sass, Autoprefixer, Bourbon/Neat/Bitters, Browserify, Imagemin, Browsersync, etc.__

## Features

- Gulp
- Sass
- Autoprefixer
- Bourbon/Neat/Bitters
- Browserify
- Watchify
- UglifyJS
- Imagemin
- Browsersync

Bourbon is a lightweight Sass framework. If you don't use it, it will do nothing to your CSS file.

## System Preparation

To use this starter project, you'll need the following things installed on your machine.

1. [Jekyll](http://jekyllrb.com/) - `$ gem install jekyll`
2. [NodeJS](http://nodejs.org) - use the installer, Homebrew, etc.

## Local Installation

1. Clone this repo, or download it into a directory of your choice.
2. Inside the directory, run `npm install`.

## Usage

### Development Mode

This will give you file watching, browser synchronisation, auto-rebuild, CSS injecting, etc.

```shell
$ npm start
```

Or, if you have installed Gulp globally, this is also available and is same as `npm start`.

```shell
$ gulp
```

#### Build for Production

This will set the `JEKYLL_ENV` to `production` and use the production config file(s) set in `gulpconfig.json` to override default settings.

```shell
$ npm run build-production
```

#### To See More Commands

This will display all available commands.

```shell
$ npm run
```

### Jekyll

As this is just a Jekyll project, you can use any of the commands listed in their [docs](http://jekyllrb.com/docs/usage/)

## Configurations and Defaults

You can change the configurations by editing `frascoconfig.json`

### port

default: `4000`
options: integer

### tasks

Tasks to run when you exec `npm start` or `gulp` commands.

#### browserify

To use Browserify.

default: `true`
options: boolean (`true` / `false`)

#### imagemin

To minify images.

default: `true`
options: boolean (`true` / `false`)

#### sass

To compile Sass.

default: `true`
options: boolean (`true` / `false`)

#### server

To compile sources via Jekyll and to keep browsers in sync with file changes via Browsersync.

default: `true`
options: boolean (`true` / `false`)

#### watch

To watch files and run tasks on file changes.

### paths

Settings about paths.

#### dest

The destination directory for the whole project.

default: `"_site"`
options: string

#### posts

The directory of posts source files.

default: `"_posts"`
options: string

#### assets

The directory to gather all assets.

default: `"./assets"`
options: string
example: `"./"` (directly under the theme direcotry)

#### css

The CSS destination directory for Sass.

default: `"css"`
options: string
example: `"stylesheets"`

#### js

The JavaScript destination directory for Browserify.

default: `"js"`
options: string
example: `"javascripts"`

#### images

The destination directory of compressed image files for Imagemin.

default: `"images"`
options: string
example: `"img"`

#### sass

The directory of Sass files.

default: `"_sass"`
options: string
example: `"src/sass"`

#### jsSrc

The directory of JavaScript source files to bundle up by Browserify.

default: `"_js"`
options: string
example: `"src/js`"

#### imagesSrc

The directory of image source files to compress.

default: `"_images"`
options: string
example: `"src/images"`

### jekyll

Jekyll settings.

#### config

Jekyll config files.

##### default

The default Jekyll config file(s).

default: `"_config.yml`
options: string (`"FILE1[,FILE2,...]"`)
example: `"_config1.yml,_config2.yml`

##### development

Development mode config file(s) to override default settings.

default: `""`
options: string (`"FILE1[,FILE2,...]"`)
example: `"_config_development"`

##### production

Production mode config file(s) to override default settings.

default: `""`
options: string (`"FILE1[,FILE2,...]"`)
example: `"_config_production"`

### sass

Sass settings.

#### outputStyle

The output style of Sass.

default: `"compressed"`
options: `"expanded"`, `"nested"`, `"compact"`, `"compressed"`

### autoprefixer

Autoprefixer settings.

#### browsers

List of browsers, which are supported in your theme.

default: `["> 1%", "last 2 versions", "Firefox ESR"]`
options: array. See [Browserslist docs](https://github.com/ai/browserslist#queries) for available queries.
example: `["> 5%", "last 2 versions", "IE 8"]`

### js

JavaScript settings.

#### src

File name(s) of JavaScript source file(s).

default: `["main.js"]`
options: array
example: `["pluginA.js", "pluginB.js", "main.js"]`

#### dist

The distribution JavaScript file name.

default: `"main.js"`
options: string
example: `"script.js"`

## Copyright / License

Copyright © 2015-2016 the contributors of the Frasco project under the [MIT License](https://github.com/ixkaito/frasco/blob/master/LICENSE).
16 changes: 16 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Site settings
title: My New Frasco Site
description: Jekyll starter project including full setup for Gulp, Sass, Autoprefixer, Bourbon/Neat/Bitters, Browserify, Imagemin, Browsersync, etc.
url: http://ixkaito.github.io # the base hostname & protocol for your site
baseurl: '/frasco' # the subpath of your site, e.g. /blog

# Build settings
markdown: kramdown
exclude:
- node_modules
- gulpfile.js
- frascoconfig.json
- package.json
- npm-debug.log
- README.md
- LICENSE
2 changes: 2 additions & 0 deletions _config_development.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
url: ''
baseurl: ''
4 changes: 4 additions & 0 deletions _includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
</div><!-- /.container -->
<script src="{{ "/assets/js/main.js" | prepend: site.baseurl }}" type="text/javascript"></script>
</body>
</html>
Loading

0 comments on commit 96124fe

Please sign in to comment.