Izar Jekyll documentation

FAQ and support

Answers to common questions about Izar, fixes for common problems, and how to reach us.

Can I use Izar for a client’s site?

One license covers one website, yours or a client’s. See Licensing.

Do I need to know how to code?

No. You edit text files: _config.yml, page files, and one Markdown file for each project and note. You do need to run two commands to preview the site on your computer, or you can let GitHub Pages, Cloudflare or Netlify build it for you.

Can I add more pages?

Yes. Make a file such as about.md with layout: page, a permalink: and a sections: list, and add a link to izar.nav in _config.yml. See Sections. For a plain page of text, use layout: page with no sections and write below the front matter.

Can I use a section twice?

Yes. Give each copy its own id, such as id: work-recent and id: work-archive, so the menu links and page addresses don’t clash.

Can I remove Notes, or Works?

Yes. Delete the Notes link from izar.nav and the files notes.md, notes-tags.md and _posts/. Remove any notes sections from your pages. For Works, do the same with works.md and _projects/, and remove works sections. Notes link to /notes/, /notes/tags/ and /contact/, so keep those pages if you keep notes.

Can I switch off the light/dark button, or the fade-in?

Yes. Set theme_switch: false and reveal: false under izar: in _config.yml. See Site settings.

Can I use it in light mode?

Yes. Set color_scheme: light, or auto to follow each visitor’s device. See Colours, fonts and words.

Can I translate it?

Yes. Every word the theme prints is in _data/strings.yml. Translate it, set lang: in _config.yml, and write your own pages in your language. See Colours, fonts and words.

Where are the demo’s pictures?

The portrait, three project screenshots and the testimonial photos are only on the live demo. Your download has stand-ins with the same names. See Pictures.

My site shows the README instead of the page

GitHub Pages isn’t building with Jekyll. Check that index.md starts with --- front matter and layout: home, and that Pages deploys from the branch and folder that hold _config.yml.

On a project site (username.github.io/repository), set baseurl: "/repository" in _config.yml. On username.github.io, a custom domain, Cloudflare or Netlify, keep it empty.

The build fails after I edited a page

Usually YAML. Check that the indentation matches the examples and uses spaces, not tabs. Text with a colon followed by a space needs quotes: text: "Note: I'm away in August.". The error shows in the output of bundle exec jekyll serve, or under Actions on GitHub.

A project doesn’t show on the home page

The works section shows projects with featured: true, up to its limit (3 for staggered, 4 for grid). Set featured: true on the project, or use items to pick them yourself. To show more than three, add limit: 5 (or any number) to the section in index.md; step by step in Showing more or fewer projects.

The link comes from site_url. A field called url is ignored, because Jekyll reserves it for the page’s own address.

A picture doesn’t show

With widths, the files must be named <src>-<width>.webp, such as kiko-360.webp. Check the file names, the .webp ending and that src starts with a slash and has no width at the end. See Pictures.

I have two topics for the same word

Topics are the exact text in tags. “Front-end” and “front end” are different topics. Pick one spelling and use it in every note.

Messages from the form never arrive

Check that izar.form.provider isn’t still demo, that the Web3Forms key or Formspree address is right, and look in your spam folder. The first Formspree message asks you to confirm your email address. See Contact form.

Support

Support is the same for every theme. See the support guide for how to reach us and what to include.