Browse Source

Merge commit '0504885'

Brendan Abolivier 1 year ago
parent
commit
af6891422c
1 changed files with 29 additions and 0 deletions
  1. 29
    0
      README.md

+ 29
- 0
README.md View File

@@ -5,6 +5,7 @@ It pairs a prominent sidebar with uncomplicated content.
5 5
 
6 6
 ![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png)
7 7
 
8
+**Note: this is a fork I (Brendan Abolivier) made to adapt Hyde to my needs. More info [below](#fork).**
8 9
 
9 10
 ## Contents
10 11
 
@@ -19,6 +20,7 @@ It pairs a prominent sidebar with uncomplicated content.
19 20
 - [Author](#author)
20 21
 - [Ported by](#ported-by)
21 22
 - [License](#license)
23
+- [Fork](#fork)
22 24
 
23 25
 
24 26
 ## Installation
@@ -164,3 +166,30 @@ googleAnalytics: Your tracking code
164 166
 Open sourced under the [MIT license](LICENSE.md).
165 167
 
166 168
 <3
169
+
170
+## Fork
171
+
172
+This is a fork of the Hyde theme I (Brendan Abolivier) made containing a few changes I made:
173
+
174
+* Getting rid of Google Fonts
175
+* Adding FontAwesome
176
+* Adding meta tags for social network sharing and kind of SEO
177
+* Adding an `author` key in the `params` section from the configuration file
178
+* Adding special links to the sidebar menu using values from the `params` section in the configuration file:
179
+
180
+| Configuration key | Description                                                       | Example value                                     |
181
+|-------------------|-------------------------------------------------------------------|---------------------------------------------------|
182
+| twitter           | Twitter @username                                                 | BrenAbolivier                                     |
183
+| github            | GitHub username                                                   | babolivier                                        |
184
+| email             | Email address                                                     | hello@brendanabolivier.com                        |
185
+| pgp               | PGP key fingerprint                                               | E1D4 B745 7A82 9D77 1FBA 8CAC E860 1572 74A2 8D7E |
186
+| keyserver         | The key server to use in the key's menu link (must support HTTPS) | pgp.key-server.io                                 |
187
+| creativeCommons   | The Creative Commons license                                      | by-sa                                             |
188
+
189
+* Replacing the `copyright` key in the `params` section from the configuration file with a `creativeCommons` key, expected to be a Creative Commons license identifier (such as `by`, `by-sa`, etc.)
190
+* Adding a proper RSS feed template including items' descriptions in `<description>` tags, and their contents in `<content:encoded>` tags
191
+* Adding support for posts' thumbnails, by supporting a `thumbnail` key in a post's front matter. Note that this value must not contain the `https://myblog.tld/images` part of the image's URL, which is added automatically before the key's value.
192
+
193
+Note that none of the configuration parameters I added are optional (mainly because I don't need them to be, but PRs are welcome!). A live demo is available [on my blog](https://brendan.abolivier.bzh).
194
+
195
+Of course, everything I didn't mess with belongs to the Hugo Hyde theme's authors and contributor.