al-folio  by alshedivat

Jekyll theme for building academic portfolios and personal websites

Created 10 years ago
15,836 stars

Top 3.3% on SourcePulse

GitHubView on GitHub
Project Summary

A beautiful, simple, clean, and responsive Jekyll theme for academics.

How It Works

Leveraging Jekyll, this theme generates fast, secure static sites. Its architecture focuses on academic content needs, integrating features like BibTeX-powered publications, CV formats, and a "people" collection. Responsiveness and a mobile-first design are core. GitHub Copilot agents are included to simplify customization and documentation.

Quick Start & Requirements

  • Installation: Recommended: Use "Use this template" on GitHub. Refer to QUICKSTART.md.
  • Prerequisites: Jekyll, Ruby. GitHub Copilot subscription required for agents.
  • Resources: Links to QUICKSTART.md, INSTALL.md, CUSTOMIZE.md, Jekyll tutorial.

Highlighted Details

  • Academic Features: CVs (RenderCV/JSONResume), BibTeX publications, people pages, content collections (news, projects, courses).
  • Content Richness: Distill.pub style posts, MathJax, code highlighting, charts, diagrams, multimedia embeds.
  • User Experience: Light/dark mode, social previews, Atom feed, related posts, GDPR consent.
  • Development Aids: GitHub Copilot agents, code quality checks (Prettier, lychee).

Maintenance & Community

Maintained by 4 contributors, al-folio benefits from a growing global academic user base. Contributions are welcomed via pull requests, and community examples are showcased.

Licensing & Compatibility

MIT License, permitting commercial use and integration into closed-source projects.

Limitations & Caveats

Manual execution is required for accessibility testing (Axe), with potential remediation challenges. Users must distinguish between "Use this template" and forking to avoid accidental contributions.

Health Check
Last Commit

3 days ago

Responsiveness

Inactive

Pull Requests (30d)
20
Issues (30d)
5
Star History
137 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.