jekyll-academic 1.1.0 → 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (17) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE.txt +21 -21
  3. data/README.md +108 -88
  4. data/_config.yml +46 -46
  5. data/_includes/footer.html +9 -9
  6. data/_includes/head.html +54 -54
  7. data/_includes/licenses.html +40 -40
  8. data/_includes/nav.html +20 -20
  9. data/_includes/socials.html +27 -27
  10. data/_layouts/blog.html +59 -59
  11. data/_layouts/default.html +12 -12
  12. data/_layouts/post.html +32 -32
  13. data/_layouts/projects.html +39 -39
  14. data/_layouts/tag.html +16 -16
  15. data/_sass/main.scss +225 -225
  16. data/assets/css/main.scss +4 -4
  17. metadata +6 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c998f28430563acadf9ea94505f6f2335220bcdb27f568d2401c003c5794d981
4
- data.tar.gz: f564484a88c817208c78fb0e6f54fdfd9a2227c61076705a9ec397a57dd7b4be
3
+ metadata.gz: 41d58f4186d8eadb42618689b9481e86e8c298459ec185523516f10c9aa958ad
4
+ data.tar.gz: da787f3de8db24ab9d2e7a5b763df72668d3a1161b678963d0e2ff73ab56adb3
5
5
  SHA512:
6
- metadata.gz: 96831fbab39096f183e549c2703038bd8838f380cbe83d8569464b1fb503076a98b1adfa0e17c75e29c8ff608945fc595fb925e6341dcac6e85b3f1a3155e438
7
- data.tar.gz: b205cd3c68d8fdc95d264f4b78592affe50b1465fb22e57d4263b155b2f86426ade6290eae73af2165cf51a173def14e593d88a179f387882f4f6dcaaafc9410
6
+ metadata.gz: e9300f5f323435ddc3b0690628228863821e39980094e47b63e496825fd33dc8bcc3f8b27f49010c25e97dc79e64b0fc0ebc27af7884dcb0d1b0ac27b6d525df
7
+ data.tar.gz: 12afb20ffdfa98237d5bd9679964878102a7de8b7dac9c60eb54ad7d1a6a45b74a225c3caa07b3d73bb2e25608700c7fc4f4b95ed1ba829caf303c793329a6a2
data/LICENSE.txt CHANGED
@@ -1,21 +1,21 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2021 yak-fumblepack
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2021 yak-fumblepack
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md CHANGED
@@ -1,89 +1,109 @@
1
- # Jekyll Academic
2
-
3
- Jekyll Academic is a lightweight theme for any academic usecase. Perfect for portfolio websites, blogs, and academia. It is a simple no nonsense theme that offers many features.
4
-
5
- [Live preview](https://jekyll-academic.netlify.app)
6
-
7
- - Ultra-fast serving times, only ~2.6kb of CSS
8
- - 99/100 Performance on Lighthouse
9
- - 100/100 SEO on Lighthouse
10
- - RSS and JSON feed
11
- - Enhanced Markdown (Highlightjs, MathJax, ChartJs, FontAwesome/Bootstrap Icons)
12
- - Optional Disqus comments
13
- - Search bar with blog categorisation based on tags
14
- - Custom 404 page
15
- - SEO optimised (robots.txt, sitemap.xml, jekyll-seo-tag)
16
-
17
- ## Contents
18
- - [Installation](#installation)
19
- - [Usage](#usage)
20
- - [Contributing](#contributing)
21
- - [License](#license)
22
-
23
- ## Installation
24
-
25
- ### Quick install
26
-
27
- Download this [file](https://downgit.github.io/#/home?url=https://github.com/yak-fumblepack/jekyll-academic/blob/dev/scripts/bundle-install.sh) and run it.
28
-
29
- ```shell
30
- $ ./bundle-install.sh
31
- ```
32
-
33
- ### Longer installation process
34
-
35
- Add this to your Jekyll site's Gemfile:
36
-
37
- ```ruby
38
- gem "jekyll-academic"
39
- ```
40
-
41
- And add this line to your Jekyll site's `_config.yml`:
42
-
43
- ```yaml
44
- theme: jekyll-academic
45
- ```
46
-
47
- Then execute:
48
-
49
- ```shell
50
- $ bundle install
51
- ```
52
-
53
- or install it yourself as a Gem:
54
-
55
- ```shell
56
- $ gem install jekyll-academic
57
- ```
58
-
59
- OR
60
-
61
- ```shell
62
- $ git clone https://github.com/yak-fumblepack/jekyll-academic.git
63
- ```
64
-
65
- ```shell
66
- $ bundle install
67
- ```
68
-
69
- Then finally to view your site (default is [localhost:4000]()):
70
-
71
- ```shell
72
- $ bundle exec jekyll serve
73
- ```
74
-
75
- ## Usage
76
-
77
- To make it yours, edit the `_config.yml` file or refer to our [docs](https://jekyll-academic.netlify.app/docs) for further configuration.
78
-
79
- Have fun building your amazing site!
80
-
81
- ## Contributing
82
-
83
- Bugfixes and features are most welcome and appreciated. Please make the pull request onto the `dev` branch.
84
-
85
- Is there a bug? Feel free to open an issue.
86
-
87
- ## License
88
-
1
+ # Jekyll Academic
2
+
3
+ ![Gem](https://img.shields.io/gem/v/jekyll-academic?color=orange&style=plastic)
4
+ ![Gem](https://img.shields.io/gem/dt/jekyll-academic?color=blue&style=plastic)
5
+
6
+ Jekyll Academic is a lightweight theme for any academic usecase. Perfect for portfolio websites, blogs, and academia. It is a simple no nonsense theme that offers many features.
7
+
8
+ [Live preview](https://jekyll-academic.netlify.app)
9
+
10
+ - Ultra-fast serving times, only ~2.6kb of CSS
11
+ - 99/100 Performance on Lighthouse
12
+ - 100/100 SEO on Lighthouse
13
+ - RSS and JSON feed
14
+ - Enhanced Markdown (Highlightjs, MathJax, ChartJs, FontAwesome/Bootstrap Icons)
15
+ - Optional Disqus comments
16
+ - Search bar with blog categorisation based on tags
17
+ - Custom 404 page
18
+ - SEO optimised (robots.txt, sitemap.xml, jekyll-seo-tag)
19
+
20
+ ## Contents
21
+ - [Jekyll Academic](#jekyll-academic)
22
+ - [Contents](#contents)
23
+ - [Installation](#installation)
24
+ - [Quick install](#quick-install)
25
+ - [Longer installation process](#longer-installation-process)
26
+ - [Usage](#usage)
27
+ - [Contributing](#contributing)
28
+ - [License](#license)
29
+
30
+ ## Installation
31
+
32
+ ### Quick install
33
+
34
+ ```shell
35
+ $ curl -s -L https://raw.githubusercontent.com/yak-fumblepack/jekyll-academic/master/scripts/bundle-install.sh | bash
36
+ ```
37
+
38
+ ### Longer installation process
39
+
40
+ Add this to your Jekyll site's Gemfile:
41
+
42
+ ```ruby
43
+ gem "jekyll-academic"
44
+ ```
45
+
46
+ And add this line to your Jekyll site's `_config.yml`:
47
+
48
+ ```yaml
49
+ theme: jekyll-academic
50
+ ```
51
+
52
+ Then execute:
53
+
54
+ ```shell
55
+ $ bundle install
56
+ ```
57
+
58
+ or install it yourself as a Gem:
59
+
60
+ ```shell
61
+ $ gem install jekyll-academic
62
+ ```
63
+
64
+ OR
65
+
66
+ ```shell
67
+ $ git clone https://github.com/yak-fumblepack/jekyll-academic.git
68
+ ```
69
+
70
+ ```shell
71
+ $ bundle install
72
+ ```
73
+
74
+ Then finally to view your site (default is [localhost:4000]()):
75
+
76
+ ```shell
77
+ $ bundle exec jekyll serve
78
+ ```
79
+
80
+ ## Usage
81
+
82
+ To make it yours, edit the `_config.yml` file or refer to our [docs](https://jekyll-academic.netlify.app/docs) for further configuration.
83
+
84
+ Have fun building your amazing site!
85
+
86
+ ## Contributing
87
+
88
+ Bugfixes and features are most welcome and appreciated. For features and bugfixes, please make the pull request onto the `dev` branch. If you're looking to improve the documentation, make the pull request onto `docs-pages`.
89
+
90
+ Is there a bug? Feel free to open an issue.
91
+
92
+ ## Development
93
+
94
+ Fork this repo
95
+
96
+ ```shell
97
+ $ git clone https://github.com/yak-fumblepack/jekyll-academic.git/
98
+ $ cd jekyll-academic/
99
+ $ bundle install
100
+ $ bundle exec jekyll serve
101
+ ```
102
+
103
+ And view it on [localhost:4000]()
104
+
105
+ Then make your amazing contributions and changes!
106
+
107
+ ## License
108
+
89
109
  This project is licensed under [MIT](https://opensource.org/licenses/MIT). See [LICENSE](https://github.com/yak-fumblepack/jekyll-academic/blob/master/LICENSE.txt) file for more details.
data/_config.yml CHANGED
@@ -1,46 +1,46 @@
1
- title: An Awesome site title
2
- navbar_title: Jekyll Academic
3
-
4
- author:
5
- name: jekyll-academic # Your name
6
- email: your-email@domain.com
7
-
8
- description: Jekyll academic is a lightweight theme for any academic usecase. Perfect for portfolio websites, blogs, and academia # description of your site
9
-
10
- url: "https://jekyll-academic.netlify.app" # The base hostname & protocol for your site, e.g. http://example.com
11
- baseurl: "" # The subpath of your site, e.g. /blog
12
-
13
- jekyllacademic:
14
- homepage_title: "Hello world" # Your homepage title
15
- disqusname: # Your disqus sitename
16
- footer: Author Year, 2021 # Your name, Year
17
- contentlicense: "MIT" # Choose either one of these to put: MIT, Commons Clause, CC BY 4.0, CC BY-NC 4.0, CC BY-ND 4.0, CC BY-NC-ND 4.0, CC BY-NC-SA 4.0, CC BY-NC-SA 4.0, CC BY-SA 4.0
18
- socials:
19
- twitter: twitter # Your twitter username
20
- github: yak-fumblepack/jekyll-academic # Your github username
21
- linkedin: unavailable # Your linkedin
22
- keybase: keybase # Your keybase
23
-
24
- # No need to edit this part, however if you want to, that's fine as well
25
-
26
- permalink: pretty
27
- markdown: kramdown
28
- kramdown:
29
- input: GFM
30
- syntax_highlighter_opts:
31
- disable: true
32
-
33
- collections:
34
- pages:
35
- output: true
36
- permalink: /:name
37
- posts:
38
- output: true
39
- permalink: /:year/:month/:day/:slug
40
- projects:
41
- output: true
42
- permalink: /:collection/:title
43
-
44
- plugins:
45
- - jekyll-sitemap
46
- - jekyll-seo-tag
1
+ title: An Awesome site title
2
+ navbar_title: Jekyll Academic
3
+
4
+ author:
5
+ name: jekyll-academic # Your name
6
+ email: your-email@domain.com
7
+
8
+ description: Jekyll academic is a lightweight theme for any academic usecase. Perfect for portfolio websites, blogs, and academia # description of your site
9
+
10
+ url: "https://jekyll-academic.netlify.app" # The base hostname & protocol for your site, e.g. http://example.com
11
+ baseurl: "" # The subpath of your site, e.g. /blog
12
+
13
+ jekyllacademic:
14
+ homepage_title: "Hello world" # Your homepage title
15
+ disqusname: # Your disqus sitename
16
+ footer: Author Year, 2021 # Your name, Year
17
+ contentlicense: "MIT" # Choose either one of these to put: MIT, Commons Clause, CC BY 4.0, CC BY-NC 4.0, CC BY-ND 4.0, CC BY-NC-ND 4.0, CC BY-NC-SA 4.0, CC BY-NC-SA 4.0, CC BY-SA 4.0
18
+ socials:
19
+ twitter: twitter # Your twitter username
20
+ github: yak-fumblepack/jekyll-academic # Your github username
21
+ linkedin: unavailable # Your linkedin
22
+ keybase: keybase # Your keybase
23
+
24
+ # No need to edit this part, however if you want to, that's fine as well
25
+
26
+ permalink: pretty
27
+ markdown: kramdown
28
+ kramdown:
29
+ input: GFM
30
+ syntax_highlighter_opts:
31
+ disable: true
32
+
33
+ collections:
34
+ pages:
35
+ output: true
36
+ permalink: /:name
37
+ posts:
38
+ output: true
39
+ permalink: /:year/:month/:day/:slug
40
+ projects:
41
+ output: true
42
+ permalink: /:collection/:title
43
+
44
+ plugins:
45
+ - jekyll-sitemap
46
+ - jekyll-seo-tag
data/_includes/footer.html CHANGED
@@ -1,10 +1,10 @@
1
- <footer class="stickyfooter text-center">
2
- <small>
3
- <div class="small"></div>
4
- &copy; {{ site.jekyllacademic.footer }}
5
- |
6
- {% include socials.html %}
7
- |
8
- Powered by <a href="https://github.com/yak-fumblepack/jekyll-academic">Jekyll Academic Theme</a>
9
- </small>
1
+ <footer class="stickyfooter text-center">
2
+ <small>
3
+ <div class="small"></div>
4
+ &copy; {{ site.jekyllacademic.footer }}
5
+ |
6
+ {% include socials.html %}
7
+ |
8
+ Powered by <a href="https://github.com/yak-fumblepack/jekyll-academic">Jekyll Academic Theme</a>
9
+ </small>
10
10
  </footer>
data/_includes/head.html CHANGED
@@ -1,55 +1,55 @@
1
- <head>
2
- <meta charset="utf-8">
3
- <meta name="viewport" content="width=device-width, initial-scale=1">
4
-
5
- <!-- Bootstrap CSS -->
6
- <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-beta3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-eOJMYsd53ii+scO/bJGFsiCZc+5NDVN2yr8+0RDqr0Ql0h+rP48ckxlpbzKgwra6" crossorigin="anonymous">
7
-
8
- <!-- Option 1: Bootstrap Bundle with Popper -->
9
- <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-beta3/dist/js/bootstrap.bundle.min.js" integrity="sha384-JEW9xMcG8R+pH31jmWH6WWP0WintQrMb4s7ZOdauHnUtxwoG2vI5DkLtS3qm9Ekf" crossorigin="anonymous"></script>
10
-
11
- <!-- Bootstrap Icons -->
12
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.4.1/font/bootstrap-icons.css">
13
-
14
- <!-- FontAwesome Icons -->
15
- <script src="https://kit.fontawesome.com/22ab6dd597.js" crossorigin="anonymous"></script>
16
-
17
- <!-- Highlight JS -->
18
- {% if page.usehighlight %}
19
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/styles/atom-one-light.min.css">
20
- <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/highlight.min.js"></script>
21
- <script>hljs.highlightAll();</script>
22
- {% endif %}
23
-
24
- <!-- Fork Awesom -->
25
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-awesome@1.1.7/css/fork-awesome.min.css" integrity="sha256-gsmEoJAws/Kd3CjuOQzLie5Q3yshhvmo7YNtBG7aaEY=" crossorigin="anonymous">
26
-
27
- <!-- ChartJS -->
28
- {% if page.usechartjs %}
29
- <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
30
- {% endif %}
31
-
32
- <!-- Mathjax support -->
33
- {% if page.usemathjax %}
34
- <script type="text/x-mathjax-config">
35
- MathJax.Hub.Config({
36
- TeX: { equationNumbers: { autoNumber: "AMS" } }
37
- });
38
- </script>
39
- <script type="text/javascript" async src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
40
- {% endif %}
41
-
42
- <!-- CSS -->
43
- <link rel="stylesheet" href="/assets/css/main.css">
44
-
45
- <!-- SEO -->
46
- <title>
47
- {% if page.title %}
48
- {{ page.title }}
49
- {% else %}
50
- {{ site.title }}
51
- {% endif %}
52
- </title>
53
- <link rel="sitemap" type="application/xml" title="sitemap" href="{{ site.baseurl }}/sitemap.xml" />
54
- {% seo title=false %}
1
+ <head>
2
+ <meta charset="utf-8">
3
+ <meta name="viewport" content="width=device-width, initial-scale=1">
4
+
5
+ <!-- Bootstrap CSS -->
6
+ <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-beta3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-eOJMYsd53ii+scO/bJGFsiCZc+5NDVN2yr8+0RDqr0Ql0h+rP48ckxlpbzKgwra6" crossorigin="anonymous">
7
+
8
+ <!-- Option 1: Bootstrap Bundle with Popper -->
9
+ <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-beta3/dist/js/bootstrap.bundle.min.js" integrity="sha384-JEW9xMcG8R+pH31jmWH6WWP0WintQrMb4s7ZOdauHnUtxwoG2vI5DkLtS3qm9Ekf" crossorigin="anonymous"></script>
10
+
11
+ <!-- Bootstrap Icons -->
12
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.4.1/font/bootstrap-icons.css">
13
+
14
+ <!-- FontAwesome Icons -->
15
+ <script src="https://kit.fontawesome.com/22ab6dd597.js" crossorigin="anonymous"></script>
16
+
17
+ <!-- Highlight JS -->
18
+ {% if page.usehighlight %}
19
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/styles/atom-one-light.min.css">
20
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/highlight.min.js"></script>
21
+ <script>hljs.highlightAll();</script>
22
+ {% endif %}
23
+
24
+ <!-- Fork Awesom -->
25
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-awesome@1.1.7/css/fork-awesome.min.css" integrity="sha256-gsmEoJAws/Kd3CjuOQzLie5Q3yshhvmo7YNtBG7aaEY=" crossorigin="anonymous">
26
+
27
+ <!-- ChartJS -->
28
+ {% if page.usechartjs %}
29
+ <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
30
+ {% endif %}
31
+
32
+ <!-- Mathjax support -->
33
+ {% if page.usemathjax %}
34
+ <script type="text/x-mathjax-config">
35
+ MathJax.Hub.Config({
36
+ TeX: { equationNumbers: { autoNumber: "AMS" } }
37
+ });
38
+ </script>
39
+ <script type="text/javascript" async src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
40
+ {% endif %}
41
+
42
+ <!-- CSS -->
43
+ <link rel="stylesheet" href="/assets/css/main.css">
44
+
45
+ <!-- SEO -->
46
+ <title>
47
+ {% if page.title %}
48
+ {{ page.title }}
49
+ {% else %}
50
+ {{ site.title }}
51
+ {% endif %}
52
+ </title>
53
+ <link rel="sitemap" type="application/xml" title="sitemap" href="{{ site.baseurl }}/sitemap.xml" />
54
+ {% seo title=false %}
55
55
  </head>