Kibble is a static site generator, it will make HTML pages using content from the SHIFT72 site.
Kibble enables Designers and Developers to have full control over their site. Kibble will give control over the HTML and CSS for your site. You need to be a Designer / Developer or an enthusiastic amateur to use Kibble.
Please ensure that you have the following installed on your system and available to your terminal/command prompt.
Instructions for your platform can be found here https://nodejs.org/.
Installing on windows - https://gitforwindows.org/.
Installing on linux and OSX - https://git-scm.com/downloads.
Newer versions of NodeJS comes with a command which helps get us started.
# create a new directory to run your site from
# npx is supported in npm v5.2+
npx s72-kibble init
# select a template from the list available
# after the template has been downloaded, you need to install any template specific node modules
# this will ensure that the correct css gets generated and kibble is started.
# your site can now be seen in your browser
Note Windows Users: Kibble will run its own local webserver. So expect to see a Window Defender message where kibble is asking to use the network, please select ‘Allow’.
Kibble manages the configuration of the site inside the
Take a moment to give your template a name, and reset the version number. The version number will need to be increased each time you publish your template.
siteUrl determines where to load your site data from. If you have a site deployed you can update this URL to load your site's active domain (or testing domain) to design against your current data.
Or use one of our pre-populated
builderVersion is the version of kibble that you have used to develop the template. This lets us know which version we should use to make your site.
When kibble is running it will be monitoring your site’s files for changes and automatically refresh the page for continuous feedback.
Bring Your Own Editor (BYOE) - vscode / sublime / notepad.
We highly recommend storing your changes in source control. You can choose any source control provider, e.g. git, TFS, subversion.
Once you are ready to see your changes live, you are going to need to publish your template.
Publishing is done using the same set of tools.
Note: You currently need to be an Administrator on the site (see siteUrl ) to be allowed to publish a template.
> [you will be asked to login]
> uploading name: firstname.lastname@example.org built with 0.9.9
> upload successful
On successful publishing, the site will be made available with the updated design!
See here (hyperlinks to another how-to guide) for a list of what you can and can't change, and what you are responsible for as a Designer / Developer.