Giter VIP home page Giter VIP logo

minimal-light's Introduction

The Minimal Light Theme

LICENSE gem Gem Jekyll Build Status

[Demo the theme] [๐Ÿ‡จ๐Ÿ‡ณ ็ฎ€ไฝ“ไธญๆ–‡]

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

Features

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

Usage

Using on GitHub

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

remote_theme: yaoyao-liu/minimal-light

Using 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

Edit 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:

minimal-light's People

Contributors

yaoyao-liu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.