Jekyll meets Bootstrap - and makes a lot of friends. J1 Template combines
the best of OpenSource software for the Web and the Web site generator
Jekyll
. J1 is OpenSource, and so are the packaged modules - no pain for
private or professional use. Explore this site to learn what's possible if
you go to the Jekyll Way.
Create powerful modern Static Webs: Secure, Flexible and Fast.
Create powerful modern Static Webs: Secure, Flexible and Fast.
Have fun!
The template comes with a Web included, a skeleton for your new Web site. This Web is called the Starter Web, a general-purpose Website scaffold to be modified for your needs. The built-in Starter Web can be visited live at Netlify.
Have fun exploring what a modern static web, a Jekyll site can do!
The template combines the best free software for the web. Jekyll One Template is OpenSource and the modules included are free to use as well. No license issues for private or professional use.
J1 is supported on all current x64-based OS:
Note that 32-bit versions (x32) are generally NOT supported for all platforms.
To run the project for J1 Template Web, the following languages and tools expected to be in place with your OS:
NodeJS comes with the package manager NPM pre-installed. The native CLI for
the NodeJS package management is npm
. Besides npm
there's another quite
handy CLI for NPM available: Yarn.
The CLI yarn
is developed at Facebook and can be used as a replacement
for npm
. From a top-level perspective, both package management clients
behave pretty much the same. The syntax yarn
uses is shorter in writing,
making the command-line look a bit more natural. Therefore, the use of
yarn
is preferred over npm
Install the latest NPM and Yarn packages for NodeJS:
npm install -g npm@latest <1>
npm install -g yarn@latest
Running the J1 template project is simple:
J1 Project Structure
├──── .
│ └─ _data <1>
│ └─ _includes <2>
│ └─ _plugins <3>
│ └─ assets <4>
│ └─ collections <5>
│ └─ pages <6>
│ └─ utilsrv
├──── _config.yml <7>
├──── config.ru
├──── .gitattributes
├──── .gitignore
├──── favicon.ico
├──── Gemfile <8>
├──── index.html <9>
└──── package.json <10>
First, install (bundle) all Ruby GEMs required. You can install the bundle with your home directory (userized):
bundle config set --local path ~/.gem
bundle install
or system-wide:
bundle install
Initializing the project is done by the NodeJS package manager yarn
running the task setup
.
The task setup
takes a while. Typically some minutes for the first
run (depending on the performances of your Internet connection and your
Desktop PC). A bunch of NPM modules and Ruby Gems gets downloaded, installed,
and linked for the project. See the setup task as an extended install and
build process to make your new website ready to use.
Let's start ...
yarn setup
Because a lot of sub-tasks getting started for a (first) setup
, see below
the output as a summary :
Setup project for first use ..
Bootstrap base modules ..
done.
Configure environment ..
done.
Create project folders ..
Create log folder ..
Create archived log folder ..
Create etc folder ..
done.
Bootstrap project modules ..
Bootstrap utility server modules ..
done.
Detect OS ..
OS detected: Windows_NT
Build site incremental ..
Configuration file: C:/J1Webs/starter/_config.yml
Source: C:/J1Webs/starter
Destination: C:/J1Webs/starter/_site
Incremental build: enabled
Generating...
J1 QuickSearch: creating search index ...
J1 QuickSearch: finished, index ready.
J1 Paginator: autopages, disabled|not configured
J1 Paginator: pagination enabled, start processing ...
J1 Paginator: finished, processed 1 pagination page|s
done in 37.609 seconds.
Auto-regeneration: disabled. Use --watch to enable.
.. build finished.
To open the site, run: yarn site
Done in 94.94s.
Running the Starter Web for development is done like so:
yarn site
The task site
does a lot for you; whatever is necessary for a full-stack
Web development. The task will put in place all needed CSS and JS components,
build the Web content, and finally run the webite in a browser.
Go, go, go ..
yarn run v1.22.10
$ run-p -s site:*
Startup the site ..
UTILSRV disabled. Not started.
Configuration file: C:/J1Webs/starter/_config.yml <1>
Source: C:/J1Webs/starter <2>
Destination: C:/J1Webs/starter/_site <3>
Incremental build: enabled
Generating...
J1 QuickSearch: recreate index disabled.
J1 Paginator: autopages, disabled|not configured
J1 Paginator: pagination enabled, start processing ...
J1 Paginator: finished, processed 1 pagination page|s
done in 9.618 seconds.
Auto-regeneration: enabled for '.'
LiveReload address: http://localhost:40001 <5>
Server address: http://localhost:40000/ <4>
Server running... press ctrl-c to stop.
LiveReload: Browser connected <6>
Your default web browser is automatically started, and the website gets loaded.
To start from the beginning, you can reset the project to the factory state.
The top-level task reset
does the resetting work for you
and cleans up each and everything except the Git repo and the NPM modules
folder node_modules
stored in the project root. Both are kept untouched
by a reset.
yarn reset
To reset the Development System completely, delete the folder node_modules
manually and start from scratch by running the setup
task again:
yarn setup
Happy Jekylling!