The profile layout is designed for creating a personal or organizational profile page in your Jekyll site. It provides a structured format to showcase a profile image, bio, social links, blog posts, and repositories.
To use the Profile layout in your Jekyll site, create a new file with the following front matter:
---
layout: profile
---
The Profile layout accepts several parameters in the front matter:
| Parameter | Default | Description |
|---|---|---|
layout |
Required | Must be set to profile |
style |
site.style |
Layout style (topbar, appbar, sidebar, or stacked) |
user_image |
site.user_image or site.github.owner.avatar_url |
Site-wide profile image configured in _config.yml |
links |
site.links |
An array of link card objects |
posts |
site.posts |
Posts to display in the blog section |
posts_limit |
site.paginate |
Number of posts to display |
Each link object in the links array can have the following properties:
| Property | Description |
|---|---|
name |
The text to display for the link |
url |
The URL the link should point to |
thumbnail |
A custom image for the link (optional) |
octicon |
An Octicon name to display instead of a thumbnail (optional) |
site.repositories is enabled.topbar, appbar, sidebar, and stacked).This example shows a basic Profile page with user information and links:
---
layout: profile
style: sidebar
links:
- name: GitHub
url: https://github.com/username
octicon: mark-github
- name: Twitter
url: https://twitter.com/username
octicon: mention
posts: site.posts
posts_limit: 5
---
user_image in _config.yml if you want to override the default GitHub profile avatar.thumbnail images instead.This layout may depend on:
masthead.html include for rendering the profile header.social.html include for displaying social links.post-timeline.html include for listing blog posts.repositories.html include for rendering repositories.Ensure these dependencies are properly set up in your Jekyll theme for the Profile layout to function correctly.