Jekyll One

QuickSearch

The Cheatsheet discusses management commands for daily use. The Template system J1 is a creation tool to build simple but fully configurable modern static websites using the generator Jekyll. No deep knowledge of using Jekyll is needed for the template system J1.

J1 Templated provides a handy command, j1, to manage and run websites created by Jekyll One. Find all commands supported below.

The command j1 is a wrapper around the top-level scripts defined in the NodeJS project file package.json. To run a J1 project, an installation of NodeJS is required.
Table 1. Project Management commands
Command Description Example

app

Run the website of a J1 project as a standalone web application. In difference to the command j1 site, the web application does not use Jekyll to serve the web. The application use the web server Puma based on web root folder _site located in the project.

 
j1 app
To run a project as a standalone web application, a previous setup is required to serve the site out of the _site folder.

generate

Creates a J1 project scaffold in folder <project name>. When the scaffold is created, change to that (project-)folder and run j1 setup to make the project ready to use.

 
j1 generate <project name>

help

Show the help message, optionally for a given subcommand (e.g. generate).

 
j1 help
j1 help generate

patch

Install available patches for a J1 project. For default, patches are installed userized in the users gem folder ~/.gem.
See more details running j1 help patch.

 
j1 patch
Installing patches are only required for the Windows platform and installed automatically if a project is being generated. For Linux or OSX platforms, the installation of patches is skipped.

rebuild

Rebuild a all sources of a project. If you run a website in development mode (j1 site), most of the changes of your content (source) is detected automatically and rebuild.

 
j1 rebuild
Fundamental changes of the configuration like the site config _config.yml (Jekyll) affect your web’s base settings, and a rebuild is required to apply those changes.

reset

Reset a J1 project to factory state. A reset of a project removes all project related files but all sources of a web are untouched.

 
j1 reset

setup

Initialize a J1 project scaffold for first use. The management of a J1 site requires NodeJS libraries and larger number of Ruby GEM files (Ruby libraies) to be installed and initialized.

 
j1 setup

site

Run the web site of a J1 project in development mode. For development, the site generator of Jekyll is running in background to detect changes on your site sources.

 
j1 site
The generator of Jekyll is running in incremental mode and rebuild modified source files automatically. If the base configuration of a website is changed, a rebuild of the web is required.
See command rebuild for more details.