How iculizhi/academicpages-stu- works
Project Type and Purpose
• This is a static site generator project built on Jekyll (Ruby), styled with Sass and deployed to GitHub Pages.
• It serves as a personal academic site (blog, publications, talks, notes, portfolio), with optional dynamic maps and comment widgets injected at build time.
File Structure
• Content Sources
• _posts, _pages, _blogs, _notes, _talks, _teaching, _publications, _portfolio, _drafts
• assets/ (CSS, JS, fonts)
• images/, files/
• _data/ (YAML: authors, navigation, UI text, comments data)
• Templating & Layout
• _layouts/ (page templates)
• _includes/ (Liquid partials for header, footer, comments, analytics, maps, etc.)
• _sass/ (SCSS modules)
• Configuration & Build
• _config.yml, _config.dev.yml, Gemfile (Ruby deps), package.json (JS deps)
• Auxiliary Generators
• markdown_generator/ (Python + Jupyter notebooks → markdown for publications & talks)
• talkmap/ (HTML + JS + Leaflet plugin → visitor map)
• Deployment Output
• _site/ (auto-generated static HTML/CSS/JS—excluded from repo)
README Insights
• The author customized academicpages and added DIY instructions.
• Build uses bundle exec jekyll liveserve.
• Python scripts preprocess bibliographic and talk data into markdown collections.
• External services (analytics, comments, visitor map) are embedded via HTML snippets in _includes/.
Main Components & Their Relationships
• Content Repositories → Jekyll Engine
• Markdown + YAML content + _data/ feeds into Liquid templates.
• Jekyll Engine
• Core runner (Ruby/Gems) reads _config.yml → processes SASS, Markdown, Liquid → outputs static files.
• Asset Pipeline
• Sass compiler → CSS
• JS (jQuery + plugins) copied to output
• Python Generators (markdown_generator & talkmap scripts)
• Input: TSV/Bib files → Output: markdown under collections → consumed by Jekyll
• Includes & Layouts
• Modular partials (_includes/analytics.html, _includes/comments.html, _includes/feature_row/, etc.) provide reusable UI blocks
• Deployment & Hosting
• GitHub Pages (serving _site/)
• Custom domain via GitHub DNS settings
• External Services
• Analytics providers (Google, custom)
• Comment providers (Disqus, Giscus, Staticman)
• Visitor map (MapMyVisitors or Leaflet bundle)
Architectural Patterns & Design Principles
• Static website generator (SSG) pattern
• Modular templating (Liquid includes + layouts)
• Content-config-template separation
• Build-time injection of external widgets (no server-side code)
• Data-driven navigation via _data/navigation.yml