Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edheltzel/flightdeck-for-jekyll-with-parcel
🚀 Flightdeck is an opinionated Jamstack starter project for Jekyll with ParcelJS.
https://github.com/edheltzel/flightdeck-for-jekyll-with-parcel
flightdeck flightdeck-foundation jekyll jekyll-blog jekyll-site jekyll-site-starter jekyll-starter parcel parcel-bundler parceljs
Last synced: 4 months ago
JSON representation
🚀 Flightdeck is an opinionated Jamstack starter project for Jekyll with ParcelJS.
- Host: GitHub
- URL: https://github.com/edheltzel/flightdeck-for-jekyll-with-parcel
- Owner: edheltzel
- License: mit
- Created: 2021-07-19T15:40:39.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-16T10:19:55.000Z (over 1 year ago)
- Last Synced: 2023-08-16T11:59:10.205Z (over 1 year ago)
- Topics: flightdeck, flightdeck-foundation, jekyll, jekyll-blog, jekyll-site, jekyll-site-starter, jekyll-starter, parcel, parcel-bundler, parceljs
- Language: SCSS
- Homepage:
- Size: 2.68 MB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Flightdeck
An opinionated Jamstack starter project for Jekyll with ParcelJS v2.
[](https://github.com/edheltzel/Flightdeck-for-Jekyll/releases/latest) [](https://github.com/jekyll/jekyll/releases/latest) [](https://github.com/edheltzel/Flightdeck-for-Jekyll/blob/master/LICENSE)
> **Note:** This is an **updated version** of the legacy workflow for [Flightdeck for Jekyll](https://github.com/edheltzel/Flightdeck-for-Jekyll-with-Gulp). The Parcel version is the recommended workflow going forward, unless you want to use [Eleveny](https://www.11ty.dev/) as your static site generator, then check out [Flightdeck](https://edheltzel/flightdeck) instead.
## Prerequisites
To install this project, you'll need the following things installed on your machine.
1. [Jekyll](http://jekyllrb.com/) & [Bundler](https://bundler.io/) - `$ gem install jekyll bundler` (We assume that you have Ruby installed already)
2. [NodeJS](http://nodejs.org) & [PNPM](https://pnpm.io/) - 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](https://code.visualstudio.com/) with the [Jekyll Snippets Extension](https://marketplace.visualstudio.com/items?itemName=edheltzel.vscode-jekyll-snippets) - 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.
```shell
git clone https://github.com/edheltzel/flightdeck-for-jekyll-with-parcel.git flightdeck
```
2. Inside the directory, run `pnpm install` -> **FYI** you can use `yarn` or `npm` in place of `pnpm`
```shell
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.
```shell
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.
```shell
pnpm run build
```
## Want more?
To display all available commands just run:
```shell
pnpm run
```
### Jekyll
As this is just a Jekyll project, you can use any of the commands listed in their [docs](https://jekyllrb.com/docs/usage/)
## What's inside the Flightdeck
- [ParcelJS v2](https://pnpm.io/)
- [Sass](http://sass-lang.com/)
- [Jampack](https://jampack.divriots.com/)