jekyll-theme-minimal-academic 1.0.1 → 1.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +37 -13
  3. data/_layouts/homepage.html +3 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e3eae5804a82d9bf0babdd46317b04924487f66e436c39907fda017971f5fb05
4
- data.tar.gz: d1961a5fa2e21ff3175919cd4a2f4f2ec7da52be9659b93ee25ffa551c7f8fab
3
+ metadata.gz: 164c105c8fa3b5afcc9ae0f5ce7dd171b751ea25d9760d91c06e52c03e39bc88
4
+ data.tar.gz: a0808b43ca368aab87805fa303a6290761d05cda724aa9fd0e623ee69dd71c0c
5
5
  SHA512:
6
- metadata.gz: 05d718236853eae8f477a1f751060a8822e8151895ecbfc2a4deb7a44552794e1f6357a188f0867152851d3038411762c60eebd64bbd916cba005d29f9bdfc7e
7
- data.tar.gz: 59d5f75845fe4dd44160b43354bf9501505cb5d96b0ca479b37bd44fc901af247870c97b3b6a5d0fdd9068ad90e4402b5a4f9fbeb8835bfda8410431546ae302
6
+ metadata.gz: 599d6aab7e009beb91bef36c21999a616db747c90b8d72ae96773d0dacd69b83c804482407ba768901c270e6bc32dd3285022487e2f6c5248777a96cda01878e
7
+ data.tar.gz: a839ea170f4a9ed567636d8ec678ff7f76a3b299a7eec6da69e7d6e781298f61627087514062220c4f1e8adf46497b30723fdf3913a7f8047af72b90ceacd92a
data/README.md CHANGED
@@ -1,7 +1,8 @@
1
- # The Minimal Academic theme
1
+ # The Minimal Academic Theme
2
2
 
3
3
  [![LICENSE](https://img.shields.io/github/license/yaoyao-liu/minimal-academic)](https://github.com/yaoyao-liu/minimal-academic/blob/master/LICENSE)
4
4
  [![gem](https://img.shields.io/gem/v/jekyll-theme-minimal-academic)](https://rubygems.org/gems/jekyll-theme-minimal-academic)
5
+ [![jekyll](https://img.shields.io/badge/built%20with-Jekyll-orange)](https://jekyllrb.com/)
5
6
 
6
7
  *This is the source code of my homepage. I build this website based on [minimal](https://github.com/orderedlist/minimal).*
7
8
  <br>
@@ -18,12 +19,33 @@
18
19
 
19
20
  ## Usage
20
21
 
22
+ ### Using on GitHub
23
+
21
24
  To use this theme, add the following to your site's `_config.yml`:
22
25
 
23
26
  ```yaml
24
27
  remote_theme: yaoyao-liu/minimal-academic
25
28
  ```
26
29
 
30
+ ### Using with Jekyll
31
+
32
+ *You need to install Ruby and Jekyll fisrt.*
33
+
34
+ Clone this repository:
35
+
36
+ ```bash
37
+ git clone https://github.com/yaoyao-liu/minimal-academic.git
38
+ cd minimal-academic
39
+ ```
40
+ Install and run:
41
+
42
+ ```bash
43
+ bundle install
44
+ bundle exec jekyll server
45
+ ```
46
+ View the live page using `localhost`:
47
+ <http://localhost:4000>. You can get the html files in `_site` folder.
48
+
27
49
  ## Customizing
28
50
 
29
51
  ### Configuration variables
@@ -31,17 +53,19 @@ remote_theme: yaoyao-liu/minimal-academic
31
53
  Minimal Academic theme will respect the following variables, if set in your site's `_config.yml`:
32
54
 
33
55
  ```yaml
34
- title: Yaoyao Liu
35
- affiliation: MPI for Informatics
36
- email: yaoyao.liu (at) mpi-inf.mpg.de
37
- google_scholar: https://scholar.google.com/citations?user=Uf9GqRsAAAAJ
38
- github_link: https://github.com/yaoyao-liu/
39
- linkedin: https://www.linkedin.com/in/liuyaoyao/
40
- avatar: /assets/img/avatar.png
41
- favicon: /assets/img/favicon.png
42
- favicon_dark: /assets/img/favicon-dark.png
43
- description: Yaoyao Liu is a Ph.D. student in computer science. His research lies in few-shot learning, meta learning, continual learning, and image generation.
44
- remote_theme: yaoyao-liu/minimal-academic
56
+ title: Your Name
57
+ affiliation: Your Affiliation
58
+ email: yourname (at) example.edu
59
+ google_scholar: https://scholar.google.com/
60
+ github_link: https://github.com/yaoyao-liu/minimal-academic
61
+ linkedin: https://www.linkedin.com/
62
+ avatar: ./assets/img/avatar.png
63
+ google_analytics: UA-111540567-4
64
+ favicon: ./assets/img/favicon.png
65
+ favicon_dark: ./assets/img/favicon-dark.png
66
+ description: The Minimal Academic is a simple and elegant jekyll theme for academic personal homepage.
67
+ canonical: https://minimal-academic.yyliu.net/
68
+ remote_theme: yaoyao-liu/minimal-academic
45
69
  ```
46
70
  ### Editing `index.md`
47
71
 
@@ -77,7 +101,7 @@ This work is licensed under a [Creative Commons Zero v1.0 Universal](https://git
77
101
 
78
102
  ## Acknowledgements
79
103
 
80
- Our project use the source code from the following repositories:
104
+ Our project uses the source code from the following repositories:
81
105
 
82
106
  * [pages-themes/minimal](https://github.com/pages-themes/minimal)
83
107
 
@@ -8,7 +8,9 @@
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <meta name="description" content="{{ site.description }}">
10
10
  <meta name="keywords" content="{{ site.title }}">
11
+ {% if site.canonical %}
11
12
  <link rel="canonical" href="{{ site.canonical }}"/>
13
+ {% endif %}
12
14
 
13
15
  <link rel="icon" media="(prefers-color-scheme:dark)" href="{{ site.favicon_dark }}" type="image/png" />
14
16
  <link rel="icon" media="(prefers-color-scheme:light)" href="{{ site.favicon }}" type="image/png" />
@@ -46,7 +48,7 @@
46
48
 
47
49
  <br>
48
50
 
49
- <p><small>Powered by the <a href="https://github.com/yaoyao-liu/minimal-academic" target="_blank" rel="noopener">Minimal Academic</a> theme for Jekyll.</small></p>
51
+ <p><small>The <a href="https://github.com/yaoyao-liu/minimal-academic" target="_blank" rel="noopener">Minimal Academic Theme</a> by <a href="https://yyliu.net/" target="_blank" rel="noopener">Yaoyao Liu</a> | Built with Jekyll</small></p>
50
52
 
51
53
  </section>
52
54
  <footer>
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-minimal-academic
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Yaoyao Liu