ultimate-jekyll-manager

Site | NPM Module | GitHub Repo

Ultimate Jekyll is a template that helps you jumpstart your Jekyll sites and is fueled by an intuitive incorporation of npm, gulp, and is fully SEO optimized and blazingly fast.

🦄 Features

• SEO Optimized: Ultimate Jekyll is fully SEO optimized.
• Blazingly Fast: Ultimate Jekyll is blazingly fast.
• NPM & Gulp: Ultimate Jekyll is fueled by an intuitive incorporation of npm and gulp.

🚀 Getting started

1. Create a repo from the Ultimate Jekyll template.
2. Clone the repo to your local machine.
3. Run these commands to get everything setup and sync'd!

   npm install
   npx uj setup
   npm start
   

📦 How to sync with the template

1. Simply run npm start in Terminal to get all the latest updates from the Ultimate Jekyll template and launch your website in the browser.

🌎 Publishing your website

1. Change the url in _config.yml to your domain.
2. Push your changes to GitHub using npm run dist in Terminal.

⛳️ Flags

• --browser=false - Disables the browser from opening when running npm start.

  npm start -- --browser=false
  

• --debug=true - Enables logging of extra information when running npm start.

  npm start -- --debug=true
  

• --ujPluginDevMode=true - Enables the development mode for the Ultimate Jekyll Ruby plugin.

  npm start -- --ujPluginDevMode=true
  

Running Specific Tasks

You can run specific tasks using the npm run gulp command with the appropriate task name.

Some of these require environment variables to be set and other tasks to be run first.

Here are some examples:

Run the audit task:

npx uj audit

Run the translation task:

GH_TOKEN=XXX \
GITHUB_REPOSITORY=XXX \
UJ_TRANSLATION_CACHE=true \
npx uj translation

🛠 Developing

1. Clone the repo to your local machine.
2. Run these commands

   npm install
   npm run prepare:watch