The Minimal Light Theme for Project Pages

Getting Started

This template can be used in the following two ways:

Using with the GitHub Pages Service. GitHub will provide you with a server to generate and host web pages.
Using locally with Jekyll. You may install Jekyll on your own computer and generate static web pages (i.e., HTML files) with this template. After that, you may upload the HTML files to your server.

The detailed instructions are available below.

There are two ways to use this template on GitHub:

Fork this repository (or use this repository as a template) and change the name to your-username.github.io.
Enable the GitHub pages for that repository following the steps here.

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

remote_theme: yaoyao-liu/minimal-light-project-pages

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.

First, install Ruby and Jekyll. The install instructions can be found here: https://jekyllrb.com/docs/installation/#guides

Then, clone this repository:

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

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.

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

Our project uses the source code from the following repositories: