Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/academicpages/academicpages.github.io/llms.txt

Use this file to discover all available pages before exploring further.

The author: block in _config.yml controls everything that appears in the left-hand sidebar of your Academic Pages site. Every field is optional: if a field is left blank, its corresponding icon and link will not appear. Fill in only the profiles that are relevant to your work, and the sidebar will adapt automatically. The logic that renders these fields lives in _includes/author-profile.html, which you can customize further if needed.
Fields in the # Repositories and software development and # Social media sections expect a username (not a full URL) unless otherwise noted. The template constructs the full link automatically. Fields in # Academic websites and selected social fields (mastodon, medium, telegram) expect a full URL.

​
Biographic Information

_config.yml
author:
  avatar           : "profile.png"
  name             : "Your Sidebar Name"
  pronouns         : # example: "she/her"
  bio              : "Short biography for the left-hand sidebar"
  location         : "Earth"
  employer         : "Red Brick University"
  uri              : # URL
  email            : "none@example.org"
​
author.avatar
string
Filename of your profile photo, located in /images/. For example, "profile.png" resolves to /images/profile.png. You may also supply a full external URL (e.g. "https://example.com/photo.jpg").
​
author.name
string
Your display name as it appears as a heading in the sidebar <h3> element.
​
author.pronouns
string
Optional pronouns displayed below your name (e.g. "she/her", "they/them"). Leave blank to hide this line.
​
author.bio
string
A one- or two-sentence biography shown in the sidebar beneath your name and pronouns.
​
author.location
string
Your city or institution location. Rendered with a map-pin icon; visible only on wider screens (desktop sidebar).
​
author.employer
string
Your current institution or company. Rendered with a building/columns icon; visible only on wider screens.
​
author.uri
string
A personal or institutional website URL. Rendered as a “Website” link with a link icon.
​
author.email
string
Your email address. Rendered as a mailto: link with an envelope icon.

​
Academic Websites

These fields accept full URLs to your profiles on academic networking and indexing platforms. All use Academicons for their sidebar icons.
_config.yml
  # Academic websites
  academia         : # URL
  arxiv            : # URL
  googlescholar    : "https://scholar.google.com/citations?user=PS_CX0AAAAAJ"
  inspire-hep      : # URL
  impactstory      : # URL
  orcid            : "https://orcid.org/yourorcidurl"
  semantic         : # URL
  ssrn             : # URL
  pubmed           : "https://www.ncbi.nlm.nih.gov/pubmed/?term=john+snow"
  researchgate     : # URL
  scopus           : # URL
  zotero           : # URL

academia

Full URL to your Academia.edu profile page.

arxiv

Full URL to your arXiv author page.

googlescholar

Full URL to your Google Scholar citations profile.

inspire-hep

Full URL to your INSPIRE-HEP author record. Primarily relevant for physics researchers.

impactstory

Full URL to your Impactstory profile tracking open-science activity.

orcid

Full URL to your ORCID record, e.g. https://orcid.org/0000-0000-0000-0000.

semantic

Full URL to your Semantic Scholar author page.

ssrn

Full URL to your SSRN author page. Common in economics, law, and social sciences.

pubmed

Full URL to a PubMed author search, e.g. https://www.ncbi.nlm.nih.gov/pubmed/?term=your+name.

researchgate

Full URL to your ResearchGate profile. Note: uses a Font Awesome icon, not Academicons.

scopus

Full URL to your Scopus author profile.

zotero

Full URL to your public Zotero library or profile.

​
Repositories and Software Development

These fields accept usernames (not URLs). The template automatically prepends the appropriate service base URL.
_config.yml
  # Repositories and software development
  bitbucket        : # Username
  codepen          : # Username
  dribbble         : # Username
  github           : "academicpages"
  kaggle           : # Username
  stackoverflow    : # User number or "1/jeff-atwood"
​
author.bitbucket
string
Your Bitbucket username. Renders a link to https://bitbucket.org/[username].
​
author.codepen
string
Your CodePen username. Renders a link to https://codepen.io/[username].
​
author.dribbble
string
Your Dribbble username. Renders a link to https://dribbble.com/[username].
​
author.github
string
Your GitHub username. Renders a link to https://github.com/[username].
​
author.kaggle
string
Your Kaggle username. Renders a link to https://kaggle.com/[username].
​
author.stackoverflow
string
Your Stack Overflow user number, or user number and name separated by a slash (e.g. "1" or "1/jeff-atwood"). Renders a link to https://www.stackoverflow.com/users/[value].

​
Social Media

Most social media fields accept a username; exceptions (mastodon, medium, telegram) require a full URL because their profile URL formats are not standardized.
_config.yml
  # Social media
  artstation       : # Username
  bluesky          : "bsky.app"  # Replace with your Bluesky username
  facebook         : # Username
  flickr           : # Username
  foursquare       : # Username
  goodreads        : # Username
  google_plus      : # Username
  keybase          : # Username
  instagram        : # Username
  lastfm           : # Username
  linkedin         : # Username
  mastodon         : # URL
  medium           : # URL
  pinterest        : # Username
  soundcloud       : # Username
  steam            : # Username
  telegram         : # URL
  tumblr           : # Username
  twitter          : # Username for X / Twitter
  vine             : # Username
  weibo            : # Username
  wikipedia        : # Username
  xing             : # Username
  youtube          : # Username
  zhihu            : # Username
FieldLinks to
artstationhttps://www.artstation.com/[username]
blueskyhttps://bsky.app/profile/[username]
facebookhttps://www.facebook.com/[username]
flickrhttps://www.flickr.com/[username]
foursquarehttps://foursquare.com/[username]
goodreadshttps://www.goodreads.com/[username]
google_plushttps://plus.google.com/+[username]
keybasehttps://keybase.io/[username]
instagramhttps://instagram.com/[username]
lastfmhttps://last.fm/user/[username]
linkedinhttps://www.linkedin.com/in/[username]
pinteresthttps://www.pinterest.com/[username]
soundcloudhttps://soundcloud.com/[username]
steamhttps://steamcommunity.com/id/[username]
tumblrhttps://[username].tumblr.com
twitterhttps://twitter.com/[username] — displayed as X (formerly Twitter)
vinehttps://vine.co/u/[username]
weibohttps://www.weibo.com/[username]
wikipediahttps://en.wikipedia.org/wiki/User:[username]
xinghttps://www.xing.com/profile/[username]
youtubehttps://www.youtube.com/@[username]
zhihuhttps://www.zhihu.com/people/[username]
The twitter field renders the icon as X (using fa-x-twitter) but still links to twitter.com. The label displayed is “X (formerly Twitter)”.

​
How the Sidebar is Rendered

The sidebar is produced by _includes/author-profile.html. The rendering logic is simple: if a field has a value, the corresponding icon and link appear; if the field is blank or commented out, that entry is omitted entirely. There is no need to set fields to false — simply leaving them empty (or using the YAML comment #) is sufficient. Location and employer entries are marked with the CSS class author__desktop, which means they are only visible at desktop screen widths (≥1024 px). All link entries are visible at all widths.
Do not leave placeholder text like "Your Name" or "none@example.org" in production. Replace every field with your real information or leave it blank to suppress the icon entirely.

Build docs developers (and LLMs) love

Get started for freeTalk to us