jekyll-theme-minimalistic 0.2.0 → 0.2.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +674 -674
  3. data/README.md +176 -172
  4. data/_includes/footer.html +6 -4
  5. data/_includes/head-custom-google-analytics.html +10 -10
  6. data/_includes/head-custom.html +12 -12
  7. data/_includes/sidebar.html +56 -56
  8. data/_layouts/default.html +63 -62
  9. data/_layouts/post.html +14 -14
  10. data/_sass/colors.scss +126 -124
  11. data/_sass/fonts.scss +55 -55
  12. data/_sass/jekyll-theme-minimalistic.scss +315 -314
  13. data/_sass/minimalistic.scss +4 -4
  14. data/_sass/rouge-github.scss +206 -206
  15. data/assets/css/colors-auto.scss +25 -25
  16. data/assets/css/colors-dark.scss +14 -14
  17. data/assets/css/colors-light.scss +8 -8
  18. data/assets/css/style.scss +69 -69
  19. data/assets/fonts/Noto-Sans-700/Noto-Sans-700.eot +0 -0
  20. data/assets/fonts/Noto-Sans-700/Noto-Sans-700.svg +336 -336
  21. data/assets/fonts/Noto-Sans-700/Noto-Sans-700.ttf +0 -0
  22. data/assets/fonts/Noto-Sans-700/Noto-Sans-700.woff +0 -0
  23. data/assets/fonts/Noto-Sans-700/Noto-Sans-700.woff2 +0 -0
  24. data/assets/fonts/Noto-Sans-700italic/Noto-Sans-700italic.eot +0 -0
  25. data/assets/fonts/Noto-Sans-700italic/Noto-Sans-700italic.svg +334 -334
  26. data/assets/fonts/Noto-Sans-700italic/Noto-Sans-700italic.ttf +0 -0
  27. data/assets/fonts/Noto-Sans-700italic/Noto-Sans-700italic.woff +0 -0
  28. data/assets/fonts/Noto-Sans-700italic/Noto-Sans-700italic.woff2 +0 -0
  29. data/assets/fonts/Noto-Sans-italic/Noto-Sans-italic.eot +0 -0
  30. data/assets/fonts/Noto-Sans-italic/Noto-Sans-italic.svg +337 -337
  31. data/assets/fonts/Noto-Sans-italic/Noto-Sans-italic.ttf +0 -0
  32. data/assets/fonts/Noto-Sans-italic/Noto-Sans-italic.woff +0 -0
  33. data/assets/fonts/Noto-Sans-italic/Noto-Sans-italic.woff2 +0 -0
  34. data/assets/fonts/Noto-Sans-regular/Noto-Sans-regular.eot +0 -0
  35. data/assets/fonts/Noto-Sans-regular/Noto-Sans-regular.svg +335 -335
  36. data/assets/fonts/Noto-Sans-regular/Noto-Sans-regular.ttf +0 -0
  37. data/assets/fonts/Noto-Sans-regular/Noto-Sans-regular.woff +0 -0
  38. data/assets/fonts/Noto-Sans-regular/Noto-Sans-regular.woff2 +0 -0
  39. data/assets/img/logo.jpg +0 -0
  40. data/assets/js/scale.fix.js +27 -27
  41. metadata +33 -5
data/README.md CHANGED
@@ -1,172 +1,176 @@
1
- # jekyll-minimalistic
2
-
3
- ![GitHub top language](https://img.shields.io/github/languages/top/vaibhavvikas/jekyll-minimalistic)
4
- ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/vaibhavvikas/jekyll-minimalistic)
5
- ![GitHub stars](https://img.shields.io/github/stars/vaibhavvikas/jekyll-minimalistic)
6
- ![pages-build-deployment](https://github.com/vaibhavvikas/jekyll-minimalistic/actions/workflows/pages/pages-build-deployment/badge.svg)
7
-
8
- A fork of gh-pages minimal theme with navigation in the sidebar. You can view a live demo at [Minimalistic](https://vaibhavvikas.github.io/jekyll-minimalistic/).
9
-
10
- ## Usage
11
-
12
- To use the Minimalistic theme:
13
-
14
- 1. Add the following line to your Gemfile
15
-
16
- ```ruby
17
- gem "jekyll-remote-theme"
18
- ```
19
-
20
- then run `bundle install` to install the plugin.
21
-
22
- 2. Add the following to your site's `_config.yml` to activate the plugin:
23
-
24
- ```yml
25
- plugins:
26
- - jekyll-remote-theme
27
- ```
28
-
29
- Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
30
-
31
- 3. Add the following line to your `config.yml` to use the theme
32
-
33
- ```yml
34
- remote_theme: vaibhavvikas/jekyll-minimalistic
35
- ```
36
-
37
- then running `bundle exec jekyll serve` for local deployment.
38
-
39
- ## Customizing
40
-
41
- ### Configuration variables
42
-
43
- Minimalistic will respect the following variables, if set in your site's `_config.yml`:
44
-
45
- ```yml
46
- title: [The title of your site]
47
- description: [A short description of your site's purpose]
48
- ```
49
-
50
- Additionally, you may choose to set the following optional variables:
51
-
52
- ```yml
53
- google_analytics: [Your Google Analytics tracking ID]
54
- ```
55
-
56
- Choose light, dark, or automatically adjusting theme based on system theme:
57
-
58
- ```yml
59
- color-scheme: auto/light/dark
60
- ```
61
-
62
- Specify logo for the website:
63
-
64
- ```yml
65
- logo: /assets/img/<logo_file>
66
- ```
67
-
68
- Enable favicon by putting a `favicon.ico` in the repo's root directory and add the following line in `config.yml`:
69
-
70
- ```yml
71
- favicon: true
72
- ```
73
-
74
- ### Customizing Sidebar
75
-
76
- You can define a list of platforms that are linked from the sidebar in `_config.yml`:
77
-
78
- ```yml
79
- platforms:
80
- - name: GitHub
81
- icon: <i class="fa-brands fa-github"></i>
82
- link: https://github.com/vaibhavvikas
83
- - name: LinkedIn
84
- icon: <i class="fa-brands fa-linkedin"></i>
85
- link: https://www.linkedin.com/in/vaibhavvikas
86
- - ...
87
- ```
88
-
89
- ### Navigation
90
-
91
- You can also define, hyperlinks for specific pages or section of a pages (very helpful if creating multipage documentation or easy navigation between multiple sections).
92
-
93
- For adding navigation do the following steps:
94
-
95
- 1. Put your .md files in the root directory. and add the below text on top of pages to get it converted to html by jekyll.
96
-
97
- ```yml
98
- ---
99
- layout: default
100
- ---
101
- ```
102
-
103
- 2. Use the navigation example below to add navigation section in _config.yml file. Treat all your .md files as .html files. Currently it only supports one nesting in sublist.
104
-
105
- ```yml
106
- navigation:
107
- - name: Readme
108
- link: ./index.html
109
- sublist:
110
- - name: Image
111
- link: ./index.html#small-image
112
- - name: Another Page
113
- link: ./another-page.html
114
- - ...
115
- ```
116
-
117
- ### Example:
118
-
119
- [Live Example](https://vaibhavvikas.github.io/jekyll-minimalistic/)\
120
- [Code used in GitHub page](https://github.com/vaibhavvikas/jekyll-minimalistic/tree/gh-pages)
121
-
122
- Lets say you have a file name xyz.md, you put that into the root dir. Now, add the text in step 1 at the top of the md file. After that for the text in _config.yml you will put it like:
123
-
124
- ```yml
125
- navigation:
126
- - name: [Write name of your hyperlink]
127
- link: ./xyz.html
128
- ```
129
-
130
- ### Stylesheet
131
-
132
- If you'd like to add your own custom styles:
133
-
134
- 1. Create a file called `/assets/css/style.scss` in your site
135
- 2. Add the following content to the top of the file, exactly as shown:
136
-
137
- ```scss
138
- ---
139
- ---
140
-
141
- @import "{{ site.theme }}";
142
- ```
143
-
144
- 3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
145
-
146
- *Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
147
-
148
- ### Customizing Google Analytics code
149
-
150
- Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into `_includes/head-custom-google-analytics.html` in your Jekyll site.
151
-
152
- ## Previewing the theme locally
153
-
154
- If you'd like to preview the theme locally (for example, in the process of proposing a change):
155
-
156
- 1. Clone down the theme's repository (`git clone https://github.com/vaibhavvikas/jekyll-minimalistic`)
157
- 2. `cd` into the theme's directory
158
- 3. Run `script/bootstrap` to install the necessary dependencies
159
- 4. Run `bundle exec jekyll serve` to start the preview server
160
- 5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
161
-
162
- ## Running tests
163
-
164
- The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` once before the test script will work.
165
-
166
- ## Contributors
167
-
168
- All contributions are welcome.
169
-
170
- ## Credits:
171
-
172
- This theme was built using [Minimalist](https://github.com/BDHU/minimalist) theme by BDHU and [Minimal](https://github.com/pages-themes/minimal) by GithHub.
1
+ # jekyll-theme-minimalistic
2
+
3
+
4
+ [![Featured](https://img.shields.io/badge/featured%20on-JekyllThemes-red.svg)](https://jekyll-themes.com/jekyll-theme-minimalistic/)
5
+ [![GitHub top language](https://img.shields.io/github/languages/top/vaibhavvikas/jekyll-theme-minimalistic)](#)
6
+ [![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/vaibhavvikas/jekyll-theme-minimalistic)](#)
7
+ [![GitHub stars](https://img.shields.io/github/stars/vaibhavvikas/jekyll-theme-minimalistic)](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/stargazers)
8
+ [![Ruby Gem](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/actions/workflows/gem-push.yml/badge.svg)](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/actions/workflows/gem-push.yml)
9
+ [![pages-build-deployment](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/actions/workflows/pages/pages-build-deployment)
10
+
11
+
12
+ A fork of gh-pages minimal theme with navigation in the sidebar. You can view a live demo at [Minimalistic](https://vaibhavvikas.github.io/jekyll-theme-minimalistic/).
13
+
14
+ ## Usage
15
+
16
+ To use the Minimalistic theme:
17
+
18
+ 1. Add the following line to your Gemfile
19
+
20
+ ```ruby
21
+ gem "jekyll-remote-theme"
22
+ ```
23
+
24
+ then run `bundle install` to install the plugin.
25
+
26
+ 2. Add the following to your site's `_config.yml` to activate the plugin:
27
+
28
+ ```yml
29
+ plugins:
30
+ - jekyll-remote-theme
31
+ ```
32
+
33
+ Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
34
+
35
+ 1. Add the following line to your `config.yml` to use the theme
36
+
37
+ ```yml
38
+ remote_theme: vaibhavvikas/jekyll-theme-minimalistic
39
+ ```
40
+
41
+ then running `bundle exec jekyll serve` for local deployment.
42
+
43
+ ## Customizing
44
+
45
+ ### Configuration variables
46
+
47
+ Minimalistic will respect the following variables, if set in your site's `_config.yml`:
48
+
49
+ ```yml
50
+ title: [The title of your site]
51
+ description: [A short description of your site's purpose]
52
+ ```
53
+
54
+ Additionally, you may choose to set the following optional variables:
55
+
56
+ ```yml
57
+ google_analytics: [Your Google Analytics tracking ID]
58
+ ```
59
+
60
+ Choose light, dark, or automatically adjusting theme based on system theme:
61
+
62
+ ```yml
63
+ color-scheme: auto/light/dark
64
+ ```
65
+
66
+ Specify logo for the website:
67
+
68
+ ```yml
69
+ logo: /assets/img/<logo_file>
70
+ ```
71
+
72
+ Enable favicon by putting a `favicon.ico` in the repo's root directory and add the following line in `config.yml`:
73
+
74
+ ```yml
75
+ favicon: true
76
+ ```
77
+
78
+ ### Customizing Sidebar
79
+
80
+ You can define a list of platforms that are linked from the sidebar in `_config.yml`:
81
+
82
+ ```yml
83
+ platforms:
84
+ - name: GitHub
85
+ icon: <i class="fa-brands fa-github"></i>
86
+ link: https://github.com/vaibhavvikas
87
+ - name: LinkedIn
88
+ icon: <i class="fa-brands fa-linkedin"></i>
89
+ link: https://www.linkedin.com/in/vaibhavvikas
90
+ - ...
91
+ ```
92
+
93
+ ### Navigation
94
+
95
+ You can also define, hyperlinks for specific pages or section of a pages (very helpful if creating multipage documentation or easy navigation between multiple sections).
96
+
97
+ For adding navigation do the following steps:
98
+
99
+ 1. Put your .md files in the root directory. and add the below text on top of pages to get it converted to html by jekyll.
100
+
101
+ ```yml
102
+ ---
103
+ layout: default
104
+ ---
105
+ ```
106
+
107
+ 2. Use the navigation example below to add navigation section in _config.yml file. Treat all your .md files as .html files. Currently it only supports one nesting in sublist.
108
+
109
+ ```yml
110
+ navigation:
111
+ - name: Readme
112
+ link: ./index.html
113
+ sublist:
114
+ - name: Image
115
+ link: ./index.html#small-image
116
+ - name: Another Page
117
+ link: ./another-page.html
118
+ - ...
119
+ ```
120
+
121
+ ### Example:
122
+
123
+ [Live Example](https://vaibhavvikas.github.io/jekyll-theme-minimalistic/)\
124
+ [Code used in GitHub page](https://github.com/vaibhavvikas/jekyll-theme-minimalistic/tree/gh-pages)
125
+
126
+ Lets say you have a file name xyz.md, you put that into the root dir. Now, add the text in step 1 at the top of the md file. After that for the text in _config.yml you will put it like:
127
+
128
+ ```yml
129
+ navigation:
130
+ - name: [Write name of your hyperlink]
131
+ link: ./xyz.html
132
+ ```
133
+
134
+ ### Stylesheet
135
+
136
+ If you'd like to add your own custom styles:
137
+
138
+ 1. Create a file called `/assets/css/style.scss` in your site
139
+ 2. Add the following content to the top of the file, exactly as shown:
140
+
141
+ ```scss
142
+ ---
143
+ ---
144
+
145
+ @import "{{ site.theme }}";
146
+ ```
147
+
148
+ 3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
149
+
150
+ *Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*
151
+
152
+ ### Customizing Google Analytics code
153
+
154
+ Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into `_includes/head-custom-google-analytics.html` in your Jekyll site.
155
+
156
+ ## Previewing the theme locally
157
+
158
+ If you'd like to preview the theme locally (for example, in the process of proposing a change):
159
+
160
+ 1. Clone down the theme's repository (`git clone https://github.com/vaibhavvikas/jekyll-theme-minimalistic`)
161
+ 2. `cd` into the theme's directory
162
+ 3. Run `script/bootstrap` to install the necessary dependencies
163
+ 4. Run `bundle exec jekyll serve` to start the preview server
164
+ 5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
165
+
166
+ ## Running tests
167
+
168
+ The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` once before the test script will work.
169
+
170
+ ## Contributors
171
+
172
+ All contributions are welcome.
173
+
174
+ ## Credits:
175
+
176
+ This theme was built using [Minimalist](https://github.com/BDHU/minimalist) theme by BDHU and [Minimal](https://github.com/pages-themes/minimal) by GithHub.
@@ -1,4 +1,6 @@
1
- {% if site.github.is_project_page %}
2
- <p>This project is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
3
- {% endif %}
4
- <p><small>Powered by <a href="https://jekyllrb.com/">Jekyll</a> &mdash; Theme by <a href="https://github.com/vaibhavvikas">vaibhavvikas</a></small></p>
1
+ {% unless site.hide_project_footer %}
2
+ {% if site.github.is_project_page %}
3
+ <p>This project is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
4
+ {% endif %}
5
+ {% endunless %}
6
+ <p><small>Powered by <a href="https://jekyllrb.com/">Jekyll</a> &mdash; Theme by <a href="https://github.com/vaibhavvikas">vaibhavvikas</a></small></p>
@@ -1,10 +1,10 @@
1
- {% if site.google_analytics %}
2
- <script>
3
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
4
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
5
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
6
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
7
- ga('create', '{{ site.google_analytics }}', 'auto');
8
- ga('send', 'pageview');
9
- </script>
10
- {% endif %}
1
+ {% if site.google_analytics %}
2
+ <script>
3
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
4
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
5
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
6
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
7
+ ga('create', '{{ site.google_analytics }}', 'auto');
8
+ ga('send', 'pageview');
9
+ </script>
10
+ {% endif %}
@@ -1,12 +1,12 @@
1
- <!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
2
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free/css/all.min.css">
3
-
4
- <!-- Setup Google Analytics -->
5
- {% include head-custom-google-analytics.html %}
6
-
7
- <!-- You can set your favicon here -->
8
- {% if site.favicon %}
9
- <link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}">
10
- {% endif %}
11
-
12
- <!-- end custom head snippets -->
1
+ <!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
2
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free/css/all.min.css">
3
+
4
+ <!-- Setup Google Analytics -->
5
+ {% include head-custom-google-analytics.html %}
6
+
7
+ <!-- You can set your favicon here -->
8
+ {% if site.favicon %}
9
+ <link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}">
10
+ {% endif %}
11
+
12
+ <!-- end custom head snippets -->
@@ -1,56 +1,56 @@
1
- <div class="link-wrapper">
2
- <style scoped>
3
- h3 {
4
- margin: 1em 0 0.25em 0;
5
- }
6
-
7
- ul.link a {
8
- color:var(--clr-h1-and-bold);
9
- text-decoration:none;
10
- }
11
-
12
- ul.link a:hover, a:focus {
13
- color: var(--clr-a-text-hvr);
14
- }
15
-
16
- ul.content {
17
- margin-left: -1.4em;
18
- }
19
-
20
- ul.content a:hover, a:focus {
21
- text-decoration: underline;
22
- }
23
-
24
- .sublist {
25
- margin: 0 0 0;
26
- }
27
-
28
- ul.sublist {
29
- margin-left: -1.5em;
30
- }
31
- </style>
32
- {% if site.platforms %}
33
- <ul class="link">
34
- {%- for platform in site.platforms %}
35
- <li><a href="{{ platform.link }}">{{ platform.icon }}&nbsp;{{ platform.name }}</a></li>
36
- {%- endfor %}
37
- </ul>
38
- {% endif %}
39
-
40
- {% if site.navigation %}
41
- <h3>Contents:</h3>
42
- <ul class="content">
43
- {%- for item in site.navigation %}
44
- <li><a href="{{ item.link }}">{{ item.name }}</a>
45
- {% if item.sublist %}
46
- <ul class="sublist">
47
- {%- for subitem in item.sublist %}
48
- <li><a href="{{ subitem.link }}">{{ subitem.name }}</a></li>
49
- {%- endfor %}
50
- </ul>
51
- {% endif %}
52
- </li>
53
- {%- endfor %}
54
- </ul>
55
- {% endif %}
56
- </div>
1
+ <div class="link-wrapper">
2
+ <style scoped>
3
+ h3 {
4
+ margin: 1em 0 0.25em 0;
5
+ }
6
+
7
+ ul.link a {
8
+ color:var(--clr-h1-and-bold);
9
+ text-decoration:none;
10
+ }
11
+
12
+ ul.link a:hover, a:focus {
13
+ color: var(--clr-a-text-hvr);
14
+ }
15
+
16
+ ul.content {
17
+ margin-left: -1.4em;
18
+ }
19
+
20
+ ul.content a:hover, a:focus {
21
+ text-decoration: underline;
22
+ }
23
+
24
+ .sublist {
25
+ margin: 0 0 0;
26
+ }
27
+
28
+ ul.sublist {
29
+ margin-left: -1.5em;
30
+ }
31
+ </style>
32
+ {% if site.platforms %}
33
+ <ul class="link">
34
+ {%- for platform in site.platforms %}
35
+ <li><a href="{{ platform.link }}">{{ platform.icon }}&nbsp;{{ platform.name }}</a></li>
36
+ {%- endfor %}
37
+ </ul>
38
+ {% endif %}
39
+
40
+ {% if site.navigation %}
41
+ <h3>Contents:</h3>
42
+ <ul class="content">
43
+ {%- for item in site.navigation %}
44
+ <li><a href="{{ item.link }}">{{ item.name }}</a>
45
+ {% if item.sublist %}
46
+ <ul class="sublist">
47
+ {%- for subitem in item.sublist %}
48
+ <li><a href="{{ subitem.link }}">{{ subitem.name }}</a></li>
49
+ {%- endfor %}
50
+ </ul>
51
+ {% endif %}
52
+ </li>
53
+ {%- endfor %}
54
+ </ul>
55
+ {% endif %}
56
+ </div>