https://github.com/thecreation/jekyll-starter-kit
A starter template for Jekyll, Gulp, ECMAScript(latest), webpack3, sass and postcss.
https://github.com/thecreation/jekyll-starter-kit
Last synced: 8 months ago
JSON representation
A starter template for Jekyll, Gulp, ECMAScript(latest), webpack3, sass and postcss.
- Host: GitHub
- URL: https://github.com/thecreation/jekyll-starter-kit
- Owner: thecreation
- License: mit
- Created: 2017-08-30T20:41:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-26T13:21:39.000Z (over 8 years ago)
- Last Synced: 2025-08-17T23:43:02.508Z (10 months ago)
- Language: JavaScript
- Size: 1.06 MB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Jekyll Starter Kit
> A starter template for Jekyll, Gulp, ECMAScript(latest), webpack3, sass and postcss.
## Table of Contents
* [Features](#features)
* [Installation](#installation)
* [Getting Started](#getting-started)
* [List of Gulp tasks](#list-of-gulp-tasks)
* [Configuration](#configuration)
* [Directory Structure](#directory-structure)
* [Dockerization](#dockerization)
## Features
This starter also features a number of great software (in the words of their creators):
- [Lanyon](http://lanyon.getpoole.com/) - a content-first, sliding sidebar theme (originally) for Jekyll (by [mdo](http://mdo.fm)).
- [Gulp](http://gulpjs.com/) - a task automation tool.
- [Browsersync](https://www.browsersync.io/) - time-saving synchronised browser testing, keep multiple browsers & devices in sync when editing files.
- [EditorConfig](http://editorconfig.org/) - a config file for maintaining consistent coding styles.
### Assets
- [svgo](https://github.com/svg/svgo) - a Node.js module for optimizing SVG vector graphics files.
- [svg-sprite](https://github.com/jkphl/svg-sprite) - a Node.js module for takes a bunch of SVG files, optimizes them and bakes them into SVG sprites.
- [Favicons](https://github.com/evilebottnawi/favicons) - a Node.js module for generating favicons and their associated files.
- [imagemin](https://github.com/imagemin/imagemin) - a Node.js module for minify images seamlessly.
- [assets-manager](https://github.com/amazingsurge/assets-manager) - a Node.js module for transfer the required files from your registry distributions to the target.
### JavaScript
- [Babel](http://babeljs.io/) - a JavaScript compiler for es5 to es6/7.
- [rollup](https://rollupjs.org/) - a module bundler for JavaScript.
- [Webpack](https://webpack.github.io/) - a bundler for JavaScript.
- [ESLint](http://eslint.org/) - the pluggable linting utility for JavaScript and JSX (with preconfigured ruleset by [Google](https://github.com/google/eslint-config-google).
- [UglifyJS](https://github.com/mishoo/UglifyJS2) – A JavaScript parser, minifier, compressor or beautifier toolkit.
### StyleSheet
- [Sass](http://sass-lang.com/) - CSS with superpowers.
- [PostCSS](https://github.com/postcss/postcss) - a tool for transforming styles with JS plugins.
- [Autoprefixer](https://github.com/postcss/autoprefixer) - adding vendor prefixes by the rules of [Can I Use](http://caniuse.com/).
- [csso](https://github.com/css/csso) - a CSS minifier with structural optimizations.
- [Stylelint](http://stylelint.io/) - a mighty, modern CSS linter (with preconfigured ruleset by [Hugo Giraudel](https://sass-guidelin.es/)).
### Html
- [Jekyll](https://jekyllrb.com/) - a blog-aware, static site generator in Ruby.
- [HTMLHint](https://github.com/yaniswang/HTMLHint) - a Static Code Analysis Tool for HTML.
- [html-minifier](https://github.com/kangax/html-minifier) - a javascript-based HTML compressor/minifier.
### Jekyll plugins
- [jekyll-feed](https://github.com/jekyll/jekyll-feed) - a Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts.
- [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) - a Jekyll plugin to generate pagination for your Jekyll posts.
- [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap) - a Jekyll plugin to generate a sitemaps.org compliant sitemap.
### Rollup plugins
- [rollup-plugin-node-resolve](https://github.com/rollup/rollup-plugin-node-resolve) - Use the Node.js resolution algorithm with Rollup.
- [rollup-plugin-commonjs](https://github.com/rollup/rollup-plugin-commonjs) - Convert CommonJS modules to ES2015.
- [rollup-plugin-uglify](https://github.com/TrySound/rollup-plugin-uglify) - Rollup plugin to minify generated bundle.
### Webpack plugins
- [DefinePlugin](https://webpack.js.org/plugins/define-plugin/)
- [ProvidePlugin](https://webpack.js.org/plugins/provide-plugin/)
- [CommonsChunkPlugin](https://webpack.js.org/plugins/commons-chunk-plugin/)
- [NoEmitOnErrorsPlugin](https://webpack.js.org/plugins/no-emit-on-errors-plugin/)
- [LoaderOptionsPlugin](https://webpack.js.org/plugins/loader-options-plugin/)
- [UglifyJsPlugin](https://webpack.js.org/plugins/uglifyjs-webpack-plugin/)
- [expose-loader](https://webpack.js.org/loaders/expose-loader/)
- [BannerPlugin](https://webpack.js.org/plugins/banner-plugin/)
## Installation
### Node version manager
Install [NVM](https://github.com/creationix/nvm). And use the latest version of NodeJS.
```
nvm install node
nvm use node
```
### Install Sass
Go to [sass-lang.com/install](http://sass-lang.com/install) for installation in command line.
```
gem install sass
```
Before install sass, you should [install Ruby](https://www.ruby-lang.org/en/documentation/installation/) and [install Gem](https://rubygems.org/pages/download).
### Install Yarn
[Install Yarn globally](https://yarnpkg.com/docs/install/)
```
npm install --global yarn
```
### Install Babel
[Install Babel globally](https://babeljs.io/docs/usage/cli/#installation).
```
npm install --global babel-cli
```
### Install Gulp
[Install Gulp globally](http://gulpjs.com/).
```
npm install --global gulp-cli
```
### Install Jekyll & Bundler
[Install Jekyll and Bundler gems through RubyGems](https://jekyllrb.com/docs/quickstart/)
```
gem install jekyll bundler
```
## Getting started
1. Clone this Boilerplate
```bash
$ git clone https://github.com/amazingsurge/jekyll-starter-kit.git
$ cd
```
2. Install Dependencies
```bash
$ yarn install
```
3. Install Gem Dependencies
```bash
bundler install
```
4. Build the project
```bash
$ gulp
```
5. Stay up-to-date
```bash
$ git remote add upstream https://github.com/amazingsurge/jekyll-starter-kit.git
$ git pull upstream master
```
## List of Gulp tasks
To run separate task type in command line `gulp [task_name]`.
Almost all tasks also have watch mode - `gulp watch:[task_name]`, but you don't need to use it directly.
### Main tasks
Task name | Description
:------------------|:----------------------------------
`default` | will start all tasks required by project in dev mode: initial build, watch files, run server with livereload
`build` | builds all content and assets from `src` to `dist`.
`dev` | builds your project without optimization.
### Core tasks
Task name | Description
:------------------|:----------------------------------
`styles` | compile all scss from `src/styles` to `dist/assets/styles` folder.
`scripts` | compile all js from `src/scripts` to `dist/assets/scripts` folder.
`html` | compile all hbs files to html files.
`usemin` | replaces references to non-optimized scripts or stylesheets into a set of HTML files
### Assets related tasks
Task name | Description
:------------------|:----------------------------------
`copy` | copy files from `src/assets` path to `dist/assets` path.
`vendor` | copy vendor files from registry distributions to `dist/assets/vendor` path.
`svgs` | optimize svg files.
`sprite` | generate svg sprite.
`fonts` | copy files from `src/fonts` path to `dist/fonts` path.
`favicons` | generate favicons to `dist/assets/favicons` path.
`images` | optimize and copies images in `src/images` to `dist/assets/images`.
### Dev tasks
Task name | Description
:------------------|:----------------------------------
`clean` | remove `dist` folder.
`beautify` | beautify your source files in `src/styles` and `src/scripts`.
`server` | start a BrowserSync instance.
`watch` | watchs for changes in `src/` path and rebuilds parts of the site as necessary.
### Version tasks
Task name | Description
:------------------|:----------------------------------
`version:major` | MAJOR version when you make incompatible API changes
`version:minor` | MINOR version when you add functionality in a backwards-compatible manner
`version:patch` | PATCH version when you make backwards-compatible bug fixes.
`version` | alias to `version:path`.
All available tasks are placed in a folder `tasks`.
### Flags
* `gulp [task_name] --prod` or `gulp [task_name] --production` to run task in production mode.
### Workflow
Everything's ready to get started right away:
`npm start` - Compiles assets & html, launches development server:
- compiles styles & scripts are being compiled & concatenated
- compresses images & svgs
- builds the site & opens it in your default browser
- watches for changes and injects them right away
`npm run build` - Same as above, but in production mode:
- compiles & builds everything
- minifies & compresses everything
## Configuration
Global variables and site metadata can be found inside `config.js`. Your can make some modification in the file.
## Directory Structure
The `source` directory contains your entire application code, including CSS, JavaScript, HTML.
The rest of the folders and files only exist to make your life easier, and should not need to be touched.
Below you can find full details about significant files and folders.
```bash
├── README.md # Readme file
├── package.json # Dependencies for node.js
├── LICENSE # License
├── .babelrc # Babel config file
├── .gitignore # Git ignore rules
├── .htmlhintrc # Settings for HTMLHint
├── postcss.config.js # PostCSS config
├── gulpfile.babel.js # The Gulp task manager configuration
├── /webpack/ # Webpack config
├── /tasks/ # Gulp tasks definitions
├── /archives/ # Folder with zip archives
├── /dist/ # Minified, optimized and compiled files
│ ├── /assets/ # Assets folder
│ │ ├── /styles/ # CSS files
│ │ ├── /scripts/ # JS files
│ │ ├── /fonts/ # Fonts folder
│ │ ├── /images/ # Images folder
│ │ ├── /svgs/ # Svg files
│ │ └── /favicons/ # Favicons files
│ └── *.html # Rendered and compiled HTMLs from hbs
└── /src/ # The source code of the application
├── /assets/ # Static assets files copy to dist
├── /styles/ # Stylesheets source
├── /scripts/ # Javascript source
├── /fonts/ # Font files
├── /images/ # Non compressed image files
├── /svgs/ # Non compressed svg files
├── /favicons/ # Favicon image
```
## Dockerization
1. Build and run the Container
```bash
$ docker-compose up
```
2. Run a command in a running container
```bash
$ docker-compose exec app
```
3. Remove the old container before creating the new one
```bash
$ docker-compose rm -fs
```
## License
The code is available under the [MIT](https://github.com/amazingSurge/jekyll-starter-kit/blob/master/LICENSE) license.