Skip to content

Template for creating a simple “link in bio” site using GitHub Pages

License

Notifications You must be signed in to change notification settings

pglevy/linkinbio-template

Repository files navigation

Link in bio template

Template for creating a simple “link in bio” site using GitHub Pages.

linkinbio-template-screenshot

Getting started

Copying the template and setting up publishing

  1. Press the Use this template button on the Code tab and select Create a new repository.
  2. Go to the Settings tab and then go to the Pages settings.
  3. Set the source branch to main and press Save.

You'll see a URL show up, but the site takes a few minutes before it's actually live.

Swapping out your content

This is the content you'll want to update with your info:

  1. Name and profile blurb
  2. Avatar image and alt text
  3. Links
  4. Interests (Optional)
  5. Metadata

Name and profile blurb

  • Open index.md and change the avatar-name setting to your name.
  • Use the content area to write your profile blurb. Use GitHub-flavored Markdown for formatting.

Avatar image and alt text

  • If you don't have an existing image online to use, upload one and copy the URL.
    • Go to the assets/img folder in your repo and use the Add file action.
  • Open index.md and change avatar-url to the url of your image.
    • For example, assets/img/YOUR-FILE.jpg

Links

  • Open _data/links.yml and change the list of items, using the text, URL, and icon you want for each link.

Interests

  • Open data/interests.yml and change the list of items.
    • Put each item on a new line preceded by a hyphen and a space (- ).
    • If you want to change the text preceding the interests, open index.md and change the interest-prefix setting.

Metadata

  • Open data/metadata.yml to change the site title, description, and language information used by browsers and search engines.

Credit and license

This project was created using the GitHub Pages gem for Jekyll. It is licensed under The Unlicense, which allows everything and promises nothing.

Favicon is Soft Ice Cream from Twemoji, licensed under CC-BY 4.0.

Other parts of this project, including Primer CSS and Bootstrap, have their own licenses.