Summary
Summary
What You Just Cloned
- This is the AcademicPages Jekyll theme (Minimal Mistakes derivative) wired for GitHub Pages, so you get turnkey layouts for an academic CV site plus helper scripts for publications, talks, and maps.
- All site-wide knobs live in
_config.yml, while navigation labels and any future multilingual/UI tweaks live in_data/. - GitHub Pages will build automatically from
main, but you can preview locally withbundle install && jekyll serve -l -H localhost. Docker (docker compose up) is pre-configured if you would rather not install Ruby.
Site-Wide Configuration
_config.ymlholds the title, base URL, sidebar bio, social links, default layouts, enabled collections, and global theme (site_theme: defaultvsair). Update this first so metadata, feeds, and SEO tags are correct._data/navigation.ymldefines the order and URLs of the header menu. Add/remove entries to surface or hide sections (e.g., new pages, CV flavor, external links)._data/ui-text.ymllets you rename built-in UI strings (e.g., “Posts”, “Read More”) if you want different phrasing.
Content Buckets You Can Customize
- Blog posts (
_posts/): Markdown files must follow theYYYY-MM-DD-title.mdconvention with front matter fortitle,tags, and optionalpermalink. Draft new ideas in_drafts/until you are ready to publish. - Standalone pages (
_pages/): Anything from About, CV, Publications, custom landing pages, etc. Give each file front matter withpermalinkandtitle, then link it throughnavigation.ymlor inline buttons. - Portfolio items (
_portfolio/): Front matter controls teaser text or inline images (seeexcerptHTML). Markdown or HTML both work, so you can embed figures, slides, or video. - Publications (
_publications/): Each file stores venue metadata plus optionalpaperurl,slidesurl, andbibtexurl. These surface automatically wherever publications are rendered, so you just need to drop PDFs/slides infiles/and update the URLs. - Talks (
_talks/) and Teaching (_teaching/): Similar front matter-driven pages for seminars/lectures or course entries. You can addslidesurl,video, orlocationfields to show action buttons and badges. - Supporting data:
files/exposes uploads athttps://<username>.github.io/files/...(great for CV PDFs, slides, poster images).images/andassets/hold static media referenced in posts or CSS.
Figures, Media, and Slides
- Store figures under
images/(keep logical subfolders such asimages/research/experiment1.png). Reference them via standard Markdown () or HTML if you need sizing classes. - Hero images/backgrounds can also be attached via
header:front matter on any page/post. - Upload decks, posters, and datasets to
files/so you can link using relative URLs; GitHub Pages will serve them verbatim. Useslidesurl,paperurl,posterurl, etc., in front matter wherever you need download buttons. - Custom fonts/colors: tweak
_sass/andassets/css/main.scss(or switchsite_theme) for branding; for quick palette changes, override variables in a new partial and import it intomain.scss.
Automation Helpers
markdown_generator/contains TSV -> Markdown scripts/notebooks for bulk-importing publications or talks. Update the TSVs with your citation data, run the notebook/script, and copy the generated Markdown into_publications/or_talks/.talkmap/+talkmap.pycan build a leaflet map of your speaking history based on_talks/metadata (enabletalkmap_linkin_config.ymlonce you have real data).
Recommended Adaptation Path
- Update
_config.ymlwith your name, bio, site URL, theme choice, and analytics IDs. Double-check social links and contact info. - Rewrite the key
_pages/content (about.md,cv.md,publications.html, etc.) so each page reflects your research story; hide anything you do not need by removing it fromnavigation.yml. - Migrate your blog posts into
_posts/(or_drafts/while editing). Use tags and categories to power the archive pages already wired into the theme. - Drop figures into
images/and slides/posters intofiles/, then reference them via front matter or inline Markdown wherever relevant (portfolio cards, publication entries, talk pages). - Add portfolio case studies under
_portfolio/to highlight projects beyond papers (embed figures/gifs directly in the Markdown to keep things visual). - Use the publication/talk generators if you have structured data; otherwise, hand-author Markdown files with the provided examples as templates.
- Preview locally, iterate on styling (SCSS, theme setting), then push to the
mainbranch of<username>.github.ioto go live.
This repo already mirrors most components you need (blog, CV, publications, course list, talks, portfolio). Treat each folder as a content type, keep media in images/ or files/, and control presentation through front matter plus _config.yml.
