@yext/jamboree
v1.0.6
Published
A JAMStack implementation using Handlebars
Downloads
15
Maintainers
Keywords
Readme
Jamboree
Jamboree (Jambo for short) is a JAMStack implementation using Handlebars.
Installation
Install jamboree from npm, and save it to your package.json as a dev-dependency.
npm install -D @yext/jamboree
Usage
Jambo has 5 commands, init, import, override, page, and build.
Init
npx jambo init
Initiailizes the current directory as a Jambo repository.
The init command initializes a Jambo repo, and also imports the designated theme. Currently, only answers-hitchhiker-theme is supported.
Optional Arguments
--theme theme_name
Import a theme after initializing the repo.
Import
npx jambo import --theme answers-hitchhiker-theme
The import command imports the designated theme into the 'themes' folder.
--theme theme_name
The name of the theme to import.
Override
npx jambo override --theme answers-hitchhiker-theme
The override command lets you override a specified theme by copying its files into the overrides folder.
--theme theme_name
The name of the theme to override.
Optional Arguments
--path path_to_override
You can specify specific files(s) in the theme to override.
Page
npx jambo page --name new_page_name
The page command registers a new page, with the specified name, to be built by Jambo.
--name page_name
The name this page will be registered as.
- Optional Arguments
--theme theme_name
A theme to use with your page. Required if specifying a template.
--template template_name
The template to generate the page with.
--layout layout_name
The layout to use around the page.
Build
npx jambo build
The build command builds all pages reigstered within Jambo, and places them inside the 'public' directory.
The build command uses the 'defaultTheme' attribute in the jambo.json in Jambo's root directory, which must be added to jambo.json manually. Here is an example jambo.json.
{
"dirs": {
"themes":"themes",
"cards": "cards",
"config":"config",
"overrides":"overrides",
"output":"public",
"pages":"pages",
"layouts":"layouts"
},
"defaultTheme": "answers-hitchhiker-theme"
}