Izar Jekyll documentation

Getting started

Unzip Izar, run it on your computer, and change the first five settings to make it yours.

Thanks for choosing Izar. It’s a dark, fast portfolio theme for front-end developers and designers, built for Jekyll. Every page is a list of ready-made sections that you edit as plain text. You can see it running at the live demo, and the theme’s page is at /products/izar/.

What’s in the download

Unzip izar-jekyll-v1.0.0.zip and you get one folder, izar-jekyll, with:

  • The theme and the demo site’s pages: home, Works, Notes, Topics, Contact, thank-you and 404.
  • Six sample projects and four sample notes, so you can see how they work before replacing them.
  • Nine section types in 15 variants. The live /blocks/ catalogue shows each one, with a snippet to copy. The same page is in your copy at /blocks/ when you run the site.
  • JetBrains Mono, self-hosted, and a wrangler.jsonc for Cloudflare.

The demo’s portrait, three of its project screenshots and its testimonial photos aren’t in the download. Your copy has plain stand-in pictures with the same file names, so the site looks finished until you add your own. See Pictures.

Requirements

  • Ruby 3 and Bundler. Check with ruby -v. Install instructions are on ruby-lang.org.
  • A code editor. VS Code is free.

Install and preview

In the izar-jekyll folder:

bundle install
bundle exec jekyll serve

Open http://localhost:4000. The page rebuilds when you save a file, except _config.yml: stop the server (Ctrl+C) and start it again after changing that.

To build the finished site, run bundle exec jekyll build. It writes plain files to _site/.

The Gemfile uses the same Jekyll version GitHub Pages runs (3.10), so what you see on your computer is what goes live.

The first five settings

  1. You. In _config.yml, change title, description, url and, under izar:, your name, role, email and address. See Site settings.
  2. Your links. Replace the profiles under izar.social and the menu under izar.nav.
  3. Your home page. In index.md, change the words in each section. Delete, reorder or add sections. See Sections.
  4. Your form. Set izar.form.provider to web3forms or formspree so messages reach you. See Contact form.
  5. Your work. Replace the projects in _projects/ and the notes in _posts/. See Works and Notes.

Then replace the pictures (Pictures), set the sharing image and check the SEO list before you publish (Deploying).

Help

Stuck? See the FAQ, then the support guide.