brume 1.0.2 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +16 -16
- data/_layouts/default.html +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2aaf4ef9f22cbad28fbade2a0e0aa185adfd93ee
|
|
4
|
+
data.tar.gz: 98e10f68539faf7a3ded8623f551fafba2039021
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: af8f9e422366736e5375f4c13f952c9f37eabf6a8099a7b6a7506a22174874a31120e6c2d51dd44637a1735cdaf2926e0019f20134f11d6de02551cb01ef5e71
|
|
7
|
+
data.tar.gz: e6bced4df8283adad827510669acbf0ffc438dfa9b842ac069e4efd7d926c5baa01c5dbfe15ef2a1d757793424c51957c83dcb2ab06c6221b05871759a507a74
|
data/README.md
CHANGED
|
@@ -4,26 +4,27 @@ I am not a designer so I cannot impress you with breathtaking Jekyll themes, but
|
|
|
4
4
|
|
|
5
5
|
This is how the "Home" page looks like.
|
|
6
6
|
|
|
7
|
-
|
|
8
8
|
|
|
9
9
|
And this is a single post.
|
|
10
10
|
|
|
11
|
-
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
**Important:** The latest version of brume uses `site.baseurl` for links, therefore, if you want to put your site in a subdirectory, update the *_config.yml* file!
|
|
13
|
+
|
|
16
14
|
|
|
17
|
-
|
|
18
|
-
- Open *_config.yml* file and enter your site's URL and add additional configuration or update the existing one if needed.
|
|
19
|
-
- Open *about/index.md* file and add information about you or your site. You can delete this file and directory if not needed.
|
|
20
|
-
- Open *_data/links.yml* and add additional links or update the existing ones that you want to be displayed in the navigation menu.
|
|
21
|
-
- If you don't want to use CC BY-NC 4.0 licence for the content, then you should change the footer text, which is located in *_layouts/default.html*.
|
|
22
|
-
- Generate your site and be happy!
|
|
15
|
+
## Usage
|
|
23
16
|
|
|
24
|
-
|
|
17
|
+
Brume can be installed just like any other Jekyll theme as described [here](https://jekyllrb.com/docs/themes/#installing-a-theme),
|
|
18
|
+
but there are a couple of additional steps you have to take.
|
|
25
19
|
|
|
26
|
-
|
|
20
|
+
1. All the links are defined in a file *_data/links.yml*, therefore you'll have to create a *_data*
|
|
21
|
+
directory and put this file there in order for navigation to be displayed.
|
|
22
|
+
2. Brume uses `home` layout for the home page (like the default Jekyll theme). All you have to do
|
|
23
|
+
is create an *index.html* or *index.md* file with `layout: home` and a `title` that matches
|
|
24
|
+
the title you used for the home page link in the *links.yml* file. Titles are used to indicate
|
|
25
|
+
the current page.
|
|
26
|
+
3. Update your *_config.yml* file with `color_scheme` option, which value can be `azul`, `ruby`, `amber` or `avocado`,
|
|
27
|
+
and is used for links. It is `avocado` by default.
|
|
27
28
|
|
|
28
29
|
## Theme customization
|
|
29
30
|
|
|
@@ -34,8 +35,7 @@ This theme has 4 predefined colors that can be used for links:
|
|
|
34
35
|
- amber
|
|
35
36
|
- avocado
|
|
36
37
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
By default it uses *azure*, but if you want to select another one just change the second class of `container` div in *_layouts/default.html* to one of the provided names.
|
|
38
|
+
By default it uses *avocado*, but if you want to select another one just change the `color_scheme` setting in
|
|
39
|
+
*_config.yml* file.
|
|
40
40
|
|
|
41
41
|
Express your thoughts about brume on Twitter [@aigarsdz](http://twitter.com/aigarsdz), and help me make it better!
|
data/_layouts/default.html
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
{% include head.html %}
|
|
5
5
|
</head>
|
|
6
6
|
<body>
|
|
7
|
-
<main class="container {{ site.color_scheme }}">
|
|
7
|
+
<main class="container {% if site.color_scheme %}{{ site.color_scheme }}{% else %}avocado{% endif %}">
|
|
8
8
|
{% if page.title == "Home" %}
|
|
9
9
|
<header class="fadeInLeft animated">
|
|
10
10
|
{% else %}
|