{"id":23156557,"url":"https://github.com/thecreation/jekyll-starter-kit","last_synced_at":"2025-10-12T22:33:27.737Z","repository":{"id":149483892,"uuid":"101926824","full_name":"thecreation/jekyll-starter-kit","owner":"thecreation","description":"A starter template for Jekyll, Gulp, ECMAScript(latest), webpack3, sass and postcss.","archived":false,"fork":false,"pushed_at":"2017-09-26T13:21:39.000Z","size":1114,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-17T23:43:02.508Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thecreation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-08-30T20:41:07.000Z","updated_at":"2022-09-26T02:51:48.000Z","dependencies_parsed_at":"2023-07-30T23:02:00.067Z","dependency_job_id":null,"html_url":"https://github.com/thecreation/jekyll-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thecreation/jekyll-starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjekyll-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjekyll-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjekyll-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjekyll-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thecreation","download_url":"https://codeload.github.com/thecreation/jekyll-starter-kit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjekyll-starter-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279013269,"owners_count":26085250,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-17T21:13:58.439Z","updated_at":"2025-10-12T22:33:27.731Z","avatar_url":"https://github.com/thecreation.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jekyll Starter Kit\n\n\u003e A starter template for Jekyll, Gulp, ECMAScript(latest), webpack3, sass and postcss.\n\n## Table of Contents\n\n* [Features](#features)\n* [Installation](#installation)\n* [Getting Started](#getting-started)\n* [List of Gulp tasks](#list-of-gulp-tasks)\n* [Configuration](#configuration)\n* [Directory Structure](#directory-structure)\n* [Dockerization](#dockerization)\n\n## Features\nThis starter also features a number of great software (in the words of their creators):\n- [Lanyon](http://lanyon.getpoole.com/) - a content-first, sliding sidebar theme (originally) for Jekyll (by [mdo](http://mdo.fm)).\n- [Gulp](http://gulpjs.com/) - a task automation tool.\n- [Browsersync](https://www.browsersync.io/) - time-saving synchronised browser testing, keep multiple browsers \u0026 devices in sync when editing files.\n- [EditorConfig](http://editorconfig.org/) - a config file for maintaining  consistent coding styles.\n\n### Assets\n- [svgo](https://github.com/svg/svgo) - a Node.js module for optimizing SVG vector graphics files.\n- [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.\n- [Favicons](https://github.com/evilebottnawi/favicons) - a Node.js module for generating favicons and their associated files. \n- [imagemin](https://github.com/imagemin/imagemin) - a Node.js module for minify images seamlessly.\n- [assets-manager](https://github.com/amazingsurge/assets-manager) - a Node.js module for transfer the required files from your registry distributions to the target.\n\n### JavaScript\n- [Babel](http://babeljs.io/) - a JavaScript compiler for es5 to es6/7.\n- [rollup](https://rollupjs.org/) - a module bundler for JavaScript.\n- [Webpack](https://webpack.github.io/) - a bundler for JavaScript.\n- [ESLint](http://eslint.org/) - the pluggable linting utility for JavaScript and JSX (with preconfigured ruleset by [Google](https://github.com/google/eslint-config-google).\n- [UglifyJS](https://github.com/mishoo/UglifyJS2) – A JavaScript parser, minifier, compressor or beautifier toolkit.\n\n### StyleSheet\n- [Sass](http://sass-lang.com/) - CSS with superpowers.\n- [PostCSS](https://github.com/postcss/postcss) - a tool for transforming styles with JS plugins.\n- [Autoprefixer](https://github.com/postcss/autoprefixer) - adding vendor prefixes by the rules of [Can I Use](http://caniuse.com/).\n- [csso](https://github.com/css/csso) - a CSS minifier with structural optimizations.\n- [Stylelint](http://stylelint.io/) - a mighty, modern CSS linter (with preconfigured ruleset by [Hugo Giraudel](https://sass-guidelin.es/)).\n\n### Html\n- [Jekyll](https://jekyllrb.com/) - a blog-aware, static site generator in Ruby.\n- [HTMLHint](https://github.com/yaniswang/HTMLHint) - a Static Code Analysis Tool for HTML.\n- [html-minifier](https://github.com/kangax/html-minifier) - a javascript-based HTML compressor/minifier.\n\n### Jekyll plugins\n- [jekyll-feed](https://github.com/jekyll/jekyll-feed) - a Jekyll plugin to generate an Atom (RSS-like) feed of your Jekyll posts.\n- [jekyll-paginate](https://github.com/jekyll/jekyll-paginate) - a Jekyll plugin to generate pagination for your Jekyll posts.\n- [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap) - a Jekyll plugin to  generate a sitemaps.org compliant sitemap.\n\n### Rollup plugins\n- [rollup-plugin-node-resolve](https://github.com/rollup/rollup-plugin-node-resolve) - Use the Node.js resolution algorithm with Rollup.\n- [rollup-plugin-commonjs](https://github.com/rollup/rollup-plugin-commonjs) - Convert CommonJS modules to ES2015.\n- [rollup-plugin-uglify](https://github.com/TrySound/rollup-plugin-uglify) - Rollup plugin to minify generated bundle.\n\n### Webpack plugins\n- [DefinePlugin](https://webpack.js.org/plugins/define-plugin/)\n- [ProvidePlugin](https://webpack.js.org/plugins/provide-plugin/)\n- [CommonsChunkPlugin](https://webpack.js.org/plugins/commons-chunk-plugin/)\n- [NoEmitOnErrorsPlugin](https://webpack.js.org/plugins/no-emit-on-errors-plugin/)\n- [LoaderOptionsPlugin](https://webpack.js.org/plugins/loader-options-plugin/)\n- [UglifyJsPlugin](https://webpack.js.org/plugins/uglifyjs-webpack-plugin/)\n- [expose-loader](https://webpack.js.org/loaders/expose-loader/)\n- [BannerPlugin](https://webpack.js.org/plugins/banner-plugin/)\n\n## Installation\n\n### Node version manager\n\nInstall [NVM](https://github.com/creationix/nvm). And use the latest version of NodeJS.\n\n```\nnvm install node\nnvm use node\n```\n\n### Install Sass\n\nGo to [sass-lang.com/install](http://sass-lang.com/install) for installation in command line.\n\n```\ngem install sass\n```\n\nBefore install sass, you should [install Ruby](https://www.ruby-lang.org/en/documentation/installation/) and [install Gem](https://rubygems.org/pages/download).\n\n### Install Yarn\n\n[Install Yarn globally](https://yarnpkg.com/docs/install/)\n\n```\nnpm install --global yarn\n```\n\n### Install Babel\n\n[Install Babel globally](https://babeljs.io/docs/usage/cli/#installation).\n\n```\nnpm install --global babel-cli\n```\n\n### Install Gulp\n[Install Gulp globally](http://gulpjs.com/).\n\n```\nnpm install --global gulp-cli\n```\n\n### Install Jekyll \u0026 Bundler\n[Install Jekyll and Bundler gems through RubyGems](https://jekyllrb.com/docs/quickstart/)\n\n```\ngem install jekyll bundler\n```\n\n## Getting started\n\n1. Clone this Boilerplate\n\n```bash\n$ git clone https://github.com/amazingsurge/jekyll-starter-kit.git \u003cPROJECT_NAME\u003e\n$ cd \u003cPROJECT_NAME\u003e\n```\n\n2. Install Dependencies\n\n```bash\n$ yarn install\n```\n\n3. Install Gem Dependencies\n```bash\nbundler install\n```\n\n4. Build the project\n\n```bash\n$ gulp\n```\n\n5. Stay up-to-date\n\n```bash\n$ git remote add upstream https://github.com/amazingsurge/jekyll-starter-kit.git\n$ git pull upstream master\n```\n\n## List of Gulp tasks\n\nTo run separate task type in command line `gulp [task_name]`.\nAlmost all tasks also have watch mode - `gulp watch:[task_name]`, but you don't need to use it directly.\n\n### Main tasks\nTask name          | Description                                                      \n:------------------|:----------------------------------\n`default`          | will start all tasks required by project in dev mode: initial build, watch files, run server with livereload\n`build`            | builds all content and assets from `src` to `dist`.\n`dev`              | builds your project without optimization.\n\n### Core tasks\nTask name          | Description                                                      \n:------------------|:----------------------------------\n`styles`           | compile all scss from `src/styles` to `dist/assets/styles` folder. \n`scripts`          | compile all js from `src/scripts` to `dist/assets/scripts` folder. \n`html`             | compile all hbs files to html files.\n`usemin`           | replaces references to non-optimized scripts or stylesheets into a set of HTML files\n\n### Assets related tasks\nTask name          | Description                                                      \n:------------------|:----------------------------------\n`copy`             | copy files from `src/assets` path to `dist/assets` path.\n`vendor`           | copy vendor files from registry distributions to `dist/assets/vendor` path.\n`svgs`             | optimize svg files.\n`sprite`           | generate svg sprite.\n`fonts`            | copy files from `src/fonts` path to `dist/fonts` path.\n`favicons`         | generate favicons to `dist/assets/favicons` path.\n`images`           | optimize and copies images in `src/images` to `dist/assets/images`.\n\n### Dev tasks\nTask name          | Description                                                      \n:------------------|:----------------------------------\n`clean`            | remove `dist` folder.\n`beautify`         | beautify your source files in `src/styles` and `src/scripts`.\n`server`           | start a BrowserSync instance.\n`watch`            | watchs for changes in `src/` path and rebuilds parts of the site as necessary.\n\n### Version tasks\n\nTask name          | Description                                                      \n:------------------|:----------------------------------\n`version:major`    | MAJOR version when you make incompatible API changes\n`version:minor`    | MINOR version when you add functionality in a backwards-compatible manner\n`version:patch`    | PATCH version when you make backwards-compatible bug fixes.\n`version`          | alias to `version:path`.\n\nAll available tasks are placed in a folder `tasks`. \n\n### Flags\n* `gulp [task_name] --prod` or `gulp [task_name] --production` to run task in production mode.\n\n### Workflow\nEverything's ready to get started right away:\n\n`npm start` - Compiles assets \u0026 html, launches development server:\n- compiles styles \u0026 scripts are being compiled \u0026 concatenated\n- compresses images \u0026 svgs\n- builds the site \u0026 opens it in your default browser\n- watches for changes and injects them right away\n\n`npm run build` - Same as above, but in production mode:\n- compiles \u0026 builds everything\n- minifies \u0026 compresses everything\n\n## Configuration\nGlobal variables and site metadata can be found inside `config.js`. Your can make some modification in the file.\n\n## Directory Structure\n\nThe `source` directory contains your entire application code, including CSS, JavaScript, HTML.\n\nThe rest of the folders and files only exist to make your life easier, and should not need to be touched.\n\nBelow you can find full details about significant files and folders.\n\n```bash\n├── README.md               # Readme file\n├── package.json            # Dependencies for node.js\n├── LICENSE                 # License\n├── .babelrc                # Babel config file\n├── .gitignore              # Git ignore rules\n├── .htmlhintrc             # Settings for HTMLHint\n├── postcss.config.js       # PostCSS config\n├── gulpfile.babel.js       # The Gulp task manager configuration\n├── /webpack/               # Webpack config\n├── /tasks/                 # Gulp tasks definitions\n├── /archives/              # Folder with zip archives\n├── /dist/                  # Minified, optimized and compiled files\n│   ├── /assets/            # Assets folder\n│   │   ├── /styles/        # CSS files\n│   │   ├── /scripts/       # JS files\n│   │   ├── /fonts/         # Fonts folder\n│   │   ├── /images/        # Images folder\n│   │   ├── /svgs/          # Svg files\n│   │   └── /favicons/      # Favicons files\n│   └── *.html              # Rendered and compiled HTMLs from hbs\n└── /src/                   # The source code of the application\n    ├── /assets/            # Static assets files copy to dist\n    ├── /styles/            # Stylesheets source\n    ├── /scripts/           # Javascript source\n    ├── /fonts/             # Font files\n    ├── /images/            # Non compressed image files\n    ├── /svgs/              # Non compressed svg files\n    ├── /favicons/          # Favicon image\n```\n\n## Dockerization\n\n1. Build and run the Container\n\n```bash\n$ docker-compose up\n```\n\n2. Run a command in a running container\n\n```bash\n$ docker-compose exec app \u003cCOMMAND\u003e\n```\n\n3. Remove the old container before creating the new one\n\n```bash\n$ docker-compose rm -fs\n```\n\n## License\n\nThe code is available under the [MIT](https://github.com/amazingSurge/jekyll-starter-kit/blob/master/LICENSE) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fjekyll-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecreation%2Fjekyll-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fjekyll-starter-kit/lists"}