charmander

charmander

Charmander is a simple template for producing Jekyll static sites using Vagrant, Gulp, Bourbon, Neat, Bitters, and Bower.

Download

Charmander

Charmander is a simple template for producing Jekyll static sites using Vagrant, Gulp, Bourbon, Neat, Bitters, and Bower.

Getting Started

  1. Clone this repository locally
  2. Ensure you have Vagrant installed.
  3. From the directory you've cloned this repository in to, run sh charmander.sh serve to get started.

This will start a process which monitors both Jekyll and your static assets for changes, and will automatically generate everything any time a change is made and notify your browser to refresh the page. The command line will return something like this:

[BS] Access URLs:
 -------------------------------------------
    Local: http://localhost:3000
     External: http://10.0.2.15:3000
    Tunnel: https://ocutmjjycu.localtunnel.me

Using the tunnel URL will allow you to view your site with changes being synced in real time.

Layout

app/ # Where your jekyll site goes
assets/ # Where your static assets go

Commands

  • sh charmander.sh serve: Starts a live reload service that will automatically update browsers using the localtunnel.me URL when a change is made to any file.
  • sh charmander.sh build: Builds everything and places the final static site in _deploy

Todo

  • Minify JS
minimalacademicresumeportfoliodocumentationwikitailwindbootstrapdarkecommercegithub-pagesblog