Philzen / flightdeck-for-jekyll-with-parcel

πŸš€ Flightdeck is an opinionated Jamstack starter project for Jekyll with ParcelJS.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Flightdeck Logo

Flightdeck

An opinionated Jamstack starter project for Jekyll with ParcelJS v2.

release jekyll license

Note: This is an updated version of the legacy workflow for Flightdeck for Jekyll. The Parcel version is the recommended workflow going forward, unless you want to use Eleveny as your static site generator, then check out Flightdeck instead.

Prerequisites

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

  1. Jekyll & Bundler - $ gem install jekyll bundler (We assume that you have Ruby installed already)
  2. NodeJS & PNPM - use the installer, Homebrew, etc.

Optional Editor settings

Although your editor is a very personal thing - we'd suggest that you'd consider using Visual Studio Code with the Jekyll Snippets Extension - with the power of IntelliSense you'll get snippets to speed up your Jekyll development as well as syntax highlighting for Liquid.

Local Development & Installation

  1. Clone this repo, or download it into a directory of your choice.

    git clone https://github.com/edheltzel/Flightdeck-for-Jekyll.git flightdeck
  2. Inside the directory, run pnpm install -> FYI you can use yarn or npm in place of pnpm

cd flightdeck
pnpm install

Usage

Note: you can replace pnpm with yarn or npm in the following commands.

Start Development

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

pnpm start

Production Build

This will set the JEKYLL_ENV to production and use the production config file(s) set in flightdeck.manifest.js to override default setting. You can easily deploy your site build with the command.

pnpm run build

Want more?

To display all available commands just run:

pnpm run

Jekyll

As this is just a Jekyll project, you can use any of the commands listed in their docs

What's inside the Flightdeck

About

πŸš€ Flightdeck is an opinionated Jamstack starter project for Jekyll with ParcelJS.

License:MIT License


Languages

Language:SCSS 46.8%Language:HTML 44.1%Language:Shell 5.1%Language:Ruby 4.0%