Skip to content
main
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

The Minimal Light Theme

LICENSE gem Jekyll Build Status

[Demo the theme] [简体中文 | 繁體中文 | Deutsche]

This is the source code of my homepage. I build this website based on minimal.
Feel free to use and share the source code anywhere you like.

Features

  • Simple and elegant personal homepage theme
  • Jekyll theme, deploy automatically by GitHub pages
  • Basic Search Engine Optimization
  • Mobile friendly
  • Support Markdown
  • Support dark mode

Usage

Using on GitHub

To use this theme, add the following to your repository's _config.yml:

remote_theme: yaoyao-liu/minimal-light

Please note that adding the above line will directly apply all the default settings in this repository to yours.

If you hope to edit any files (e.g., index.md), you still need to copy them to your repository.

You may also fork this repository (or use this repository as a template) and change the name to your-username.github.io.

Then you need to enable the GitHub pages for that repository following the steps here.

Using a custom domain on GitHub

Add a CNAME DNS record to your domain as follows:

Host: whatever you want. e.g., "www" 
Target / Canonical name: your-username.github.io.
TTL: 10 min

You may also add an A DNS record instead of the CNAME record as follows:

Host: whatever you want. e.g., "www" or "@"
IP: 185.199.108.153
    185.199.109.153
    185.199.110.153
    185.199.111.153
TTL: 10 min

Then, change the contents of the CNAME file in this repository to your domain.

Using Locally with Jekyll

You need to install Ruby and Jekyll fisrt.

Clone this repository:

git clone https://github.com/yaoyao-liu/minimal-light.git
cd minimal-light

Install and run:

bundle install
bundle exec jekyll server

View the live page using localhost: http://localhost:4000. You can get the html files in _site folder.

Customizing

Configuration variables

The Minimal Light theme will respect the following variables, if set in your site's _config.yml:

title: Your Name
affiliation: Your Affiliation
email: yourname (at) example.edu
google_scholar: https://scholar.google.com/
github_link: https://github.com/yaoyao-liu/minimal-light
linkedin: https://www.linkedin.com/
avatar: ./assets/img/avatar.png
google_analytics: UA-111540567-4
favicon: ./assets/img/favicon.png
favicon_dark: ./assets/img/favicon-dark.png
description: The Minimal Light is a simple and elegant jekyll theme for academic personal homepage.
canonical: https://minimal-light.yyliu.net/
remote_theme: yaoyao-liu/minimal-light

Editing index.md

Create index.md and add your personal information (e.g. publications, research).

Stylesheet

If you'd like to add your own custom styles:

  1. Create a file called /assets/css/style.scss in your site

  2. Add the following content to the top of the file, exactly as shown:

    ---
    ---
    
    @import "{{ site.theme }}";
  3. Add any custom CSS (or Sass, including imports) you'd like immediately after the @import line

Layouts

If you'd like to change the theme's HTML layout:

  1. Copy the original template from the theme's repository
    (Pro-tip: click "raw" to make copying easier)
  2. Create a file called /_layouts/homepage.html in your site
  3. Paste the default layout content copied in the first step
  4. Customize the layout as you'd like

License

This work is licensed under a Creative Commons Zero v1.0 Universal License.

Acknowledgements

Our project uses the source code from the following repositories: