About this project

Academic Pages is a Jekyll-based GitHub Pages template intended for personal and professional portfolio websites. Users can create a repository from the template, name it with their GitHub username, configure the site in `_config.yml`, and add content in Markdown or HTML. Uploaded files placed in the `files/` directory are served from the corresponding site path. The template includes a `markdown_generator` folder with Jupyter notebooks or Python scripts that can generate Markdown pages for publications and talks from TSV data. It is derived from the Minimal Mistakes Jekyll Theme and is made available under the MIT License. For local development, the documented setup uses Ruby, Bundler, and Node.js. After installing dependencies with `bundle install`, the site can be previewed with Jekyll's local server, typically at `localhost:4000`; Markdown and HTML changes are rebuilt automatically, while configuration changes may require a restart. The repository also provides a Dockerfile and Docker Compose workflow for running the site without manually installing the full local toolchain, plus a VS Code Dev Container configuration. Maintenance guidance covers GitHub issues, discussions, pull requests, forking, and synchronization considerations for customized sites. Because it is designed as a starter template rather than a standalone hosted service, users manage their own content, configuration, GitHub repository, and deployment through GitHub Pages.