You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -25,12 +25,12 @@
25
25
26
26
## About
27
27
28
-
**Alembic is a starting point for [Jekyll](https://jekyllrb.com/) projects. Rather than starting from scratch, this boilerplate theme is designed to get the ball rolling immediately. Install it, configure it, tweak it, push it.**
28
+
**Alembic is a starting point for [Jekyll](https://jekyllrb.com/) projects. Rather than starting from scratch, this boilerplate theme is designed to get rolling immediately. Install it, configure it, tweak it, push it.**
29
29
30
30
## Features
31
31
32
32
- Available as a **theme gem** and **GitHub Pages** theme
33
-
-Simple and elegant design that can be used out of the box or as solid starting point
33
+
-Clear and elegant design that can be used out of the box or as solid starting point
34
34
- Tested in all major browsers, including **IE and Edge**
35
35
- Built in **Service Worker** so it can work offline and on slow connections
36
36
-**Configurable colours** and typography in a single settings file
@@ -128,9 +128,9 @@ Date format can be customised in the `/_config.yml` with the option `date_format
128
128
129
129
Alembic comes with a couple of options to enhance the speed and overall performance of the site you build upon it.
130
130
131
-
By default the built in Service Worker is enabled, and will work on a 'network first' method. That is, if there is no internet connection then the content the Service Worker has cached will be used until the connection comes back. It will always look for a live version of the code first. To disable the Service Worker set an option called `service_worker`to false in the `/_config.yml`.
131
+
By default the built in Service Worker is enabled, and will work on a 'network first' method. Meaning if there's no internet connection the content the Service Worker has cached will be used until the connection comes back. It will always look for a live version of the code first. To disable the Service Worker add an option called `service_worker`with a value of `false` in the `/_config.yml` file.
132
132
133
-
Another option to speed up Alembic is to enable inline CSS, which is off by default. You can enable this by setting `css_inline: true` inside your `/_config.yml` file.
133
+
Another option to speed up Alembic is to enable inline CSS, which is off by default. You can enable this by setting `css_inline: true` inside your `/_config.yml` file. By switching to inline styles you bypass the use `/assets/styles.scss`, any custom styles will need to be added in `/_includes/site-styles.html` or in a new custom file.
134
134
135
135
Please note that these options aren't a "silver bullet" for making your site faster, make sure to audit and debug your site to get the best performance for your situation.
136
136
@@ -145,7 +145,7 @@ There are a total of 4 different navigation types:
145
145
146
146
All navigations can be edited using the `_config.yml` file. To see example usage either look for the `Site navigation` comment within the `/_config.yml` file or see [the nav-share.html include](#nav-sharehtml).
147
147
148
-
If there are no items for the `navigation_header` or `navigation_footer`, they will fallback to a list of pages within the site. The `social_navigation` properties should either be one that is already in the list (so `Twitter` or `Facebook`) or simply`link`, this is so an icon can be set for the link.
148
+
If there are no items for the `navigation_header` or `navigation_footer`, they will fallback to a list of pages within the site. The `social_navigation` properties should either be one that is already in the list (so `Twitter` or `Facebook`) or a regular`link`, this is so an icon can be set for the link.
149
149
150
150
## Using includes
151
151
@@ -202,7 +202,7 @@ DesignerNews: "#2D72D9"
202
202
Email: true
203
203
```
204
204
205
-
_The first item is the name of the network (must be one of the ones stated above) and the second is the colour of the button. To remove a button just remove the line of the same name._
205
+
_The first item is the name of the network (must be one of the ones stated above) and the second is the colour of the button. To remove a button remove the line of the same name._
206
206
207
207
### `video.html`
208
208
A YouTube video.
@@ -242,7 +242,7 @@ This include has no options. This include will add a block of javascript to the
Optional html includes for adding scripts, css, js or any embed code you wish to add to every page without the need to overwrite the entire `default.html` template.
244
244
245
-
**Example usage:** These are different to other includes as they are designed to be overwritten. If you create a `site-before-start.html` file in the `_includes/` the contents of the file will be included just before the closing `</head>` tag. If you create a `site-before-end.html` file the contents of the file will be included just before the closing `</body>` tag.
245
+
**Example usage:** These are different to other includes as they are designed to be overwritten. If you create a `site-before-start.html` file in the `_includes/` the contents of the file will be included immediately before the closing `</head>` tag. If you create a `site-before-end.html` file the contents of the file will be included immediately before the closing `</body>` tag.
Copy file name to clipboardExpand all lines: _config.yml
+13-1Lines changed: 13 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -78,6 +78,18 @@ defaults:
78
78
path: ""
79
79
values:
80
80
image: "/assets/default-social-image.png"# Default image for sharing
81
+
-
82
+
scope:
83
+
path: ""
84
+
type: "posts"
85
+
values:
86
+
layout: post
87
+
-
88
+
scope:
89
+
path: ""
90
+
type: "pages"
91
+
values:
92
+
layout: page
81
93
82
94
# 7. Site settings
83
95
encoding: utf-8 # Make sure the encoding is right
@@ -93,7 +105,7 @@ email: "me@daviddarnes.com"
93
105
# google_analytics: ''
94
106
# google_analytics_anonymize_ip: ''
95
107
# service_worker: false # Will turn off the service worker if set to false
96
-
css_inline: true #Will insert all styles into a single <style> block in the <head> element and remove the style <link> reference
108
+
css_inline: true #Switches to placing styles in the <head>, note that this will skip 'assets/styles.scss' and start using '_includes/site-styles.html' instead
97
109
98
110
# 8. Site favicons & manifest icons
99
111
favicons: # Favicons are also used in the manifest file. Syntax is 'size: path'
Copy file name to clipboardExpand all lines: index.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,14 @@ excerpt: "Alembic is a starting point for [Jekyll](https://jekyllrb.com/) projec
8
8
layout: page
9
9
---
10
10
11
-
Alembic is a starting point for [Jekyll](https://jekyllrb.com/) projects. Rather than starting from scratch, this boilerplate is designed to get the ball rolling immediately. Install it, configure it, tweak it, push it.
11
+
Alembic is a starting point for [Jekyll](https://jekyllrb.com/) projects. Rather than starting from scratch, this boilerplate is designed to get rolling immediately. Install it, configure it, tweak it, push it.
12
12
13
13
{% include button.html text="Fork it" icon="github" link="https://github.com/daviddarnes/alembic" color="#0366d6" %} {% include button.html text="Tweet it" icon="twitter" link="https://twitter.com/intent/tweet/?url=https://alembic.darn.es&text=Alembic%20-%20A%20Jekyll%20boilerplate%20theme&via=DavidDarnes" color="#0d94e7" %} {% include button.html text="Install Alembic ⚗️" link="https://github.com/daviddarnes/alembic#installation" %} {% include button.html text="Tip me $5 💸" link="https://www.paypal.me/daviddarnes/5usd" color="#333333" %}
14
14
15
15
## Features
16
16
17
17
- Available as a **theme gem** and **GitHub Pages** theme
18
-
-Simple and elegant design that can be used out of the box or as solid starting point
18
+
-Clear and elegant design that can be used out of the box or as solid starting point
19
19
- Tested in all major browsers, including **IE and Edge**
20
20
- Built in **Service Worker** so it can work offline and on slow connections
21
21
-**Configurable colours** and typography in a single settings file
@@ -87,7 +87,7 @@ _(deprecated, not recommended)_
87
87
88
88
## Customising
89
89
90
-
When using Alembic as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, simply by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings.
90
+
When using Alembic as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, by matching the file name and path. The most common example of this would be if you want to add your own styles or change the core style settings.
91
91
92
92
To add your own styles copy the [`styles.scss`](https://github.com/daviddarnes/alembic/blob/master/assets/styles.scss) into your own project with the same file path (`assets/styles.scss`). From there you can add your own styles, you can even optionally ignore the theme styles by removing the `@import "alembic";` line.
0 commit comments