Git Product home page Git Product logo

jekyll-base's Introduction

WIP Jekyll starter with a focus on a lean workflow. Asset pipeline managed outside of Jekyll, via NPM

Note that this repo is updated on an ongoing basis. I just added a new structure for adding colors, based on Material Design concepts, so the colors on the built site may be funky for the moment.

Runs on

  • Jekyll 3.2
  • Bundler
  • NPM
  • BassCSS/PostCSS
  • Uglify/ESLint
  • Imagemin
  • Browser-sync
  • Anatol Broder's Compress HTML

DEMO

This is what it looks like: lean-jekyll.surge.sh

To get started:

Clone the repo: git clone https://github.com/budparr/jekyll-base.git

cd into the repo's directory
cd jekyll-base

Remove the .git folder:
rm -rf .git

Update Gems bundle update

Update node_modules
npm install

Initial build: npm run initialize

Run NPM: npm start

Layouts, includes and assets are located in the _app folder. The assets folder is built entirely from the build process, so don't add anything directly to it. Note some of the scripts copied over are particular to my use, and/or for future use here.

Roadmap

  • improve the uglify scripts in package.json, which currently reflect too many options are messy.
  • clean up design (it's a bit thrown together)
  • add basic search functionality via lunr.js
  • add page-styling unit tests (ala WP theme unit tests)
  • set up as gem-based theme?
  • add Jekyll admin (pre-beta gem is installed - needs to be run in a separate instance)

jekyll-base's People

Contributors

budparr avatar

Watchers

James Cloos avatar Thomas Krichel 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.