Ghostline is an opinionated framework for building static sites. It is built atop the Metalsmith static site generator. The framework consists of some practical code i.e. plugins as well as process and methodology.
NOTE These plugins are only designed to work within the Ghostline framework, though they may work fine outside with just standard Metalsmith they make some assumptions including that you are using handlebars for templates.
The Framework uses many plugins some developed especially for Ghostline and some Third Party.
- Handlebar Tools - Allows you to load Partials and Helpers so views have access
- Handlebar Content - Allows you to use partials in content pages
- Gallery - Allows the embedding of a gallery by scanning a folder
- Draft Excluder - Stops draft posts from been published
- Meta Loader - Loads in global metadata in a connivent easy to use way.
- Includes - Allows the including of a page and all its data in another page
- Inherit - Inherit meta data from another page
- Is Current - Find the current page
- List - Allows the listing of pages in another page
- Image Manger - Helps when embedding images
These optional plugins allow you to add extra functionality
- Image Colors - find the dominant colors in your images
- Storybook Renderer - Build a storybook out of your handlebar partials
- Meta Data Debugger - Debug issues with meta data
- Countdown - Add a counter to your site
You can install plugins individually click on a plugin to go to its readme to see how.
There are also packages for 'Base' , 'Optional' and 'All'
Installs all the plugins under the base heading above.
Install with
npm i @ghostline/bundle-<BUNDLE>
i.e.
npm i @ghostline/bundle-base You can then use them by including the individual plugins from the bundle, for example for ghostline/bundle-base
const {handlebarContents} = require('@ghostline/bundle-base');