Alcor Jekyll documentation

Site settings

Every setting in Alcor's _config.yml, from your name and availability to the footer credit.

Everything that appears in more than one place is set once in _config.yml. After changing this file, restart jekyll serve if you’re previewing on your computer.

Site basics

title: Ana Ruiz
description: Independent brand and web designer in Lisbon.
lang: en
url: "https://your-domain.com"
baseurl: ""
  • title ends every browser tab title (“Brand and web designer in Lisbon | Ana Ruiz”) and is your name if alcor.name is empty.
  • description is used by search engines and social sharing when a page has no description of its own.
  • url is your site’s full address, without a slash at the end. Search engines and social sharing need it.
  • baseurl is empty for username.github.io and custom domains, or /repository-name for a GitHub project site.

About you: alcor:

alcor:
  name: Ana Ruiz
  role: Brand and web designer
  location: Lisbon, Portugal
  email: hello@example.com
  schema_type: Person
  • name shows in the header and footer.
  • role and location tell search engines what you do and where. They don’t show on the page.
  • email shows in the contact section.
  • schema_type is Person for one person or ProfessionalService for a studio.

Availability

  availability:
    state: available
    text: Taking new projects from January

The badge at the top of the hero. state sets the dot colour: available (green), booked (amber) or closed (grey). Remove the block to hide the badge. A hero can also set its own status: with the same two fields.

Header button

  header_action:
    label: Get in touch
    url: "#contact"

The button at the right of the header, on screens wider than a tablet. Set header_action: false to hide it. The menu links come from sections that have a nav: label (see Sections).

Profiles

  social:
    - label: LinkedIn
      url: https://www.linkedin.com/in/you
      handle: in/you
    - label: GitHub
      url: https://github.com/you
      handle: you

These appear in the contact section (label, then handle, or the address if there’s no handle) and in the footer (label only). Search engines also get them as your other profiles.

Contact form

  form:
    provider: web3forms
    access_key: your-key
    subject: New message from your website

See Contact form.

  footer:
    text: Good work, *quietly* done.
  credit: true
  • footer.text is the large closing line. Words in *stars* turn vermilion and italic. Remove it to leave the footer as one small row.
  • credit shows “Theme by Tortoiz Themes” with a link. It’s how other people find this free theme, so we’d be grateful if you keep it. Set credit: false to hide it.

Favicon and sharing image

  • Replace assets/favicon.svg with your own, or point favicon: (at the top level of _config.yml) at another file.
  • The picture shown when your page is shared is set under defaults: as image: /assets/images/og.png. Make your own at 1200 × 630 pixels.

The theme’s own words

Labels such as “Menu”, “Send message”, “Your name” and “Theme by” have English defaults. To change them, or to translate them, create _data/strings.yml:

menu: Menú
send: Enviar mensaje
name: Tu nombre
email: Correo
message: Sobre tu proyecto
budget: Presupuesto
call: Llamada
credit: Tema de
skip_link: Saltar al contenido
theme_switch: Cambiar a modo claro u oscuro
thanks: Tu mensaje está en camino.
not_found: Esa página no existe.

Set lang: to match, so screen readers use the right voice.