Jekpack Star

npm version Build Status codecov

Jekyll is a powerful tool for static sites and Webpack is the first choice to pack assets. Jekpack is the integration of Jekyll and Webpack to make them work together ❀.

You may never hear about Jekyll or not familiar with Webpack. It’s ok to get started JekpackπŸ‘Œ. Start learning Jekyll by using Jekpack.

Jekpack is for multi pages static sites. If you prefer the SPA(single page application), Webpack + HtmlWebpackPlugin might be another better choice πŸ‘ˆ.


Highlights

Zero config

The Jekpack works without configuration. The default config is good enough to build common static sites.

Clean Project

We made your project tree as clean as possible. The minimal file tree might look like the following:

β”œβ”€β”€ src             
β”‚Β Β  β”œβ”€β”€ _includes   <= Jekyll includes folder
β”‚Β Β  β”œβ”€β”€ _layouts    <= Jekyll layouts folder
β”‚Β Β  β”œβ”€β”€ assets      <= Webpack is responsible to this folder
β”‚Β Β  └── index.html
β”œβ”€β”€ node_modules
└── package.json

Flexible

the default config for both Jekyll and Webpack all can be modified(see the example).

Deploy

Yes. The function of deployment is also in this pack for you. By the one command jekpack deploy <s3 bucket>, the dist will be deployed to the AWS S3 bucket.