|
1 | | -# The Minimal Light Theme |
2 | 1 |
|
3 | | -[](https://github.com/yaoyao-liu/minimal-light/blob/main/LICENSE) |
4 | | - |
5 | | -\[[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)\] |
6 | | - |
7 | | -*This is the source code of my homepage. I build this website based on [minimal](https://github.com/orderedlist/minimal).* |
8 | | -<br> |
9 | | -*Feel free to use and share the source code anywhere you like.* |
10 | | - |
11 | | -The latest version of my homepage is available here: [[link](https://github.com/yaoyao-liu/yaoyao-liu.github.io)] |
12 | | - |
13 | | -## Features |
14 | | - |
15 | | -- Simple and elegant personal homepage theme |
16 | | -- Jekyll theme, automatically deployed by GitHub Pages |
17 | | -- Basic search engine optimization |
18 | | -- Mobile friendly |
19 | | -- Supporting Markdown |
20 | | -- Supporting dark mode |
21 | | - |
22 | | -## Project Architecture |
23 | | - |
24 | | -``` |
25 | | -. |
26 | | -├── _data |
27 | | -| └── publications.yml # the YAML file for publications |
28 | | -├── _includes |
29 | | -| ├── publications.md # the Markdown file for publications |
30 | | -| └── services.md # the Markdown file for services |
31 | | -├── _layouts |
32 | | -| └── homepage.html # the html template for the homepage |
33 | | -├── _sass |
34 | | -| ├── minimal-light.scss # this file will be compiled into a CSS file to control the style of the page |
35 | | -| └── minimal-light-no-dark-mode.scss # this file is similar to minimal-light.scss with the dark mode disabled |
36 | | -├── assets # some files |
37 | | -├── html_source_file # compiled HTML files |
38 | | -├── .gitignore # this file specifies intentionally untracked files that Git should ignore |
39 | | -├── CNAME # the custom domain, will be used by GitHub page sevice |
40 | | -├── Gemfile # a RubyGems related file |
41 | | -├── LICENSE # the license file |
42 | | -├── README.md # the readme file (English) |
43 | | -├── README_de.md # the readme file (German) |
44 | | -├── README_zh_Hans.md # the readme file (Simplified Chinese) |
45 | | -├── README_zh_Hant.md # the readme file (Traditional Chinese) |
46 | | -├── _config.yml # the Jekyll configuration file, including some options of the page |
47 | | -└── index.md # the content of the index page, using Markdown |
48 | | -``` |
49 | | - |
50 | | -## Getting Started |
51 | | - |
52 | | -This template can be used in the following two ways: |
53 | | -- **Using with the GitHub Pages Service.** GitHub will provide you with a server to generate and host web pages. |
54 | | -- **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. |
55 | | - |
56 | | -The detailed instructions are available below. |
57 | | - |
58 | | - |
59 | | -### Using with the GitHub Pages Service |
60 | | - |
61 | | -There are two ways to use this template on GitHub: |
62 | | - |
63 | | -#### Fork this repository |
64 | | -- 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`. |
65 | | - |
66 | | -- 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). |
67 | | - |
68 | | -#### Using this repository as a remote theme |
69 | | -To use this theme, add the following to your repository's `_config.yml`: |
70 | | - |
71 | | -```yaml |
72 | | -remote_theme: yaoyao-liu/minimal-light |
73 | | -``` |
74 | | -
|
75 | | -Please note that adding the above line will directly apply all the default settings in this repository to yours. |
76 | | -
|
77 | | -If you hope to edit any files (e.g., `index.md`), you still need to copy them to your repository. |
78 | | - |
79 | | -### Using Locally with Jekyll |
80 | | - |
81 | | -First, install [Ruby](https://www.ruby-lang.org/en/) and [Jekyll](https://jekyllrb.com/). The install instructions can be found here: <https://jekyllrb.com/docs/installation/#guides> |
82 | | - |
83 | | -Then, clone this repository: |
84 | | - |
85 | | -```bash |
86 | | -git clone https://github.com/yaoyao-liu/minimal-light.git |
87 | | -cd minimal-light |
88 | | -``` |
89 | | -Install and run: |
90 | | - |
91 | | -```bash |
92 | | -bundle install |
93 | | -bundle add webrick |
94 | | -bundle exec jekyll server |
95 | | -``` |
96 | | -View the live page using `localhost`: |
97 | | -<http://localhost:4000>. You can get the HTML files in `_site` folder. |
98 | | - |
99 | | -### Using the HTML version |
100 | | - |
101 | | -The compiled HTML files are available in the `html_source_file` folder. If you don't like Jekyll, you may directly edit and use the HTML version. |
102 | | - |
103 | | -## Customizing |
104 | | - |
105 | | -### Configuration variables |
106 | | - |
107 | | -The Minimal Light theme will respect the following variables, if set in your site's `_config.yml`: |
108 | | - |
109 | | - ```yaml |
110 | | -# Basic Information |
111 | | -title: Your Name |
112 | | -position: Ph.D. Student |
113 | | -affiliation: Your Affiliation |
114 | | -email: yourname (at) example.edu |
115 | | -
|
116 | | -# Search Engine Optimization (SEO) |
117 | | -# The following information is used to improve the website traffic from search engines, e.g., Google. |
118 | | -keywords: minimal light |
119 | | -description: The Minimal Light is a simple and elegant jekyll theme for academic personal homepage. |
120 | | -canonical: https://minimal-light-theme.yliu.me/ |
121 | | -
|
122 | | -# Links |
123 | | -# If you don't need one of them, you may delete the corresponding line. |
124 | | -google_scholar: https://scholar.google.com/ |
125 | | -cv_link: assets/files/curriculum_vitae.pdf |
126 | | -github_link: https://github.com/ |
127 | | -linkedin: https://www.linkedin.com/ |
128 | | -twitter: https://twitter.com/ |
129 | | -
|
130 | | -# Images (e.g., your profile picture and your website's favicon) |
131 | | -# "favicon" and "favicon_dark" are used for the light and dark modes, respectively. |
132 | | -avatar: ./assets/img/avatar.png |
133 | | -favicon: ./assets/img/favicon.png |
134 | | -favicon_dark: ./assets/img/favicon-dark.png |
135 | | -
|
136 | | -# Footnote |
137 | | -# You may use the option to disable the footnote, "Powered by Jekyll and Minimal Light theme." |
138 | | -enable_footnote: true |
139 | | -
|
140 | | -# Auto Dark Mode |
141 | | -# You may use the option to disable the automatic dark theme |
142 | | -auto_dark_mode: true |
143 | | -
|
144 | | -# Font |
145 | | -# You can use this option to choose between Serif or Sans Serif fonts. |
146 | | -font: "Serif" # or "Sans Serif" |
147 | | -
|
148 | | -# Google Analytics ID |
149 | | -# Please remove this if you don't use Google Analytics |
150 | | -google_analytics: UA-111540567-4 |
151 | | - ``` |
152 | | -### Edit `index.md` |
153 | | - |
154 | | -Create `index.md` and add your personal information. It supports **Markdown** and **HTML** syntax. |
155 | | - |
156 | | -### Edit included files |
157 | | - |
158 | | -There are two markdown files included in `index.md`. They are `_includes/publications.md` and `_includes/service.md`, respectively. These two files also support **Markdown** and **HTML** syntax. If you don't hope to include these two files, you may remove the following lines in `index.md`: |
159 | | -https://github.com/yaoyao-liu/minimal-light/blob/b38070cd0b6bce45d8a885f3828549af8f82b7cb/index.md?plain=1#L21-L23 |
160 | | - |
161 | | -If you hope to edit the publication list without changing the format, you may edit `_data/publications.yml`: |
162 | | -https://github.com/yaoyao-liu/minimal-light/blob/77b1b3b31d4561091bcd739f37a2e1880e8b5ca5/_data/publications.yml#L3-L11 |
163 | | - |
164 | | - |
165 | | -### Stylesheet |
166 | | - |
167 | | -If you'd like to add your own custom styles, you may edit `_sass/minimal-light.scss`. |
168 | | - |
169 | | -### Layouts |
170 | | - |
171 | | -If you'd like to change the theme's HTML layout, you may edit `_layout/homepage.html`. |
172 | | - |
173 | | -## License |
174 | | - |
175 | | -This work is licensed under a [Creative Commons Zero v1.0 Universal](https://github.com/yaoyao-liu/minimal-light/blob/master/LICENSE) License. |
176 | | - |
177 | | -## Acknowledgements |
178 | | - |
179 | | -Our project uses the source code from the following repositories: |
180 | | - |
181 | | -* [pages-themes/minimal](https://github.com/pages-themes/minimal) |
182 | | - |
183 | | -* [orderedlist/minimal](https://github.com/orderedlist/minimal) |
184 | | - |
185 | | -* [al-folio](https://github.com/alshedivat/al-folio) |
0 commit comments