https://github.com/cdluminate/cdluminate.github.io
https://github.com/cdluminate/cdluminate.github.io
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cdluminate/cdluminate.github.io
- Owner: cdluminate
- License: cc0-1.0
- Created: 2023-01-26T15:55:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T02:23:16.000Z (7 months ago)
- Last Synced: 2025-01-11T08:48:44.526Z (4 months ago)
- Language: SCSS
- Size: 4.52 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The Minimal Light Theme
[](https://github.com/yaoyao-liu/minimal-light/blob/main/LICENSE)
\[[Demo the theme](https://minimal-light-theme.yliu.me/)\] \[[简体中文](https://github.com/yaoyao-liu/minimal-light/blob/master/README_zh_Hans.md) | [繁體中文](https://github.com/yaoyao-liu/minimal-light/blob/master/README_zh_Hant.md) | [Deutsche](https://github.com/yaoyao-liu/minimal-light/blob/master/README_de.md)\]
*This is the source code of my homepage. I build this website based on [minimal](https://github.com/orderedlist/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
- Supporting Markdown
- Supporting dark mode
## Project Architecture
```
.
├── _includes # the Markdown files for publications and services
├── _layouts
| └── homepage.html # the html template for the homepage
├── _sass
| └── minimal-light.scss # this file will be compiled into a CSS file to control the style of the page
├── assets # some files
├── .gitignore # this file specifies intentionally untracked files that Git should ignore
├── CNAME # the custom domain, will be used by GitHub page sevice
├── Gemfile # a RubyGems related file
├── LICENSE # the license file
├── README.md # the readme file (English)
├── README_de.md # the readme file (German)
├── README_zh_Hans.md # the readme file (Simplified Chinese)
├── README_zh_Hant.md # the readme file (Traditional Chinese)
├── _config.yml # the Jekyll configuration file, including some options of the page
├── index.md # the content of the index page, using Markdown
└── minimal-light.gemspec # another RubyGems related file
```
## Usage
### Using on GitHub
To use this theme, add the following to your repository's `_config.yml`:
```yaml
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](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-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](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site#creating-your-site).
### Using Locally with Jekyll
*You need to install [Ruby](https://www.ruby-lang.org/en/) and [Jekyll](https://jekyllrb.com/) fisrt.*
Clone this repository:
```bash
git clone https://github.com/yaoyao-liu/minimal-light.git
cd minimal-light
```
Install and run:
```bash
bundle install
bundle exec jekyll server
```
View the live page using `localhost`:
. 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`:
```yaml
# Basic Information
title: Your Name
position: Ph.D. Student
affiliation: Your Affiliation
email: yourname (at) example.edu
# Search Engine Optimization (SEO)
# The following information is used to improve the website traffic from search engines, e.g., Google.
keywords: minimal light
description: The Minimal Light is a simple and elegant jekyll theme for academic personal homepage.
canonical: https://minimal-light-theme.yliu.me/
# Links
# If you don't need one of them, you may delete the corresponding line.
google_scholar: https://scholar.google.com/
cv_link: files/Curriculum_Vitae.pdf
github_link: https://github.com/
linkedin: https://www.linkedin.com/
twitter: https://twitter.com/
# Images (e.g., your profile picture and your website's favicon)
# "favicon" and "favicon_dark" are used for the light and dark modes, respectively.
avatar: ./assets/img/avatar.png
favicon: ./assets/img/favicon.png
favicon_dark: ./assets/img/favicon-dark.png
# Google Analytics ID
# Please remove this if you don't use Google Analytics
google_analytics: UA-111540567-4
```
### 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:
```scss
---
---
@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](https://github.com/yaoyao-liu/minimal-light/blob/master/_layouts/homepage.html) 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](https://github.com/yaoyao-liu/minimal-light/blob/master/LICENSE) License.
## Acknowledgements
Our project uses the source code from the following repositories:
* [pages-themes/minimal](https://github.com/pages-themes/minimal)
* [orderedlist/minimal](https://github.com/orderedlist/minimal)
* [al-folio](https://github.com/alshedivat/al-folio)