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
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,12 +42,11 @@ You can configure the site using as follows:
42
42
Use the file `config.toml`.
43
43
2.### menu, footer
44
44
45
-
See the **data**files inside the `data/` directory.
45
+
See the **config.toml**file's menu areas.
46
46
47
47
> Follow the `exampleSite/`.
48
48
3. Customize Theme colors
49
49
You can do so easily in the [variables sass partial](https://github.com/onweru/hugo-swift-theme/blob/e5af8a1414cd8e1ec5a0817f8e5eb8c8c98e2676/assets/sass/_variables.sass#L13-L21). Use names (e.g red, blue, darkgoldenrod), rgb, rgba, hsla or hex values.
50
-
51
50
52
51
## Staticman Comments
53
52
@@ -61,12 +60,13 @@ To enable them, you may refer to the
61
60
62
61
1. Copy [this authors yaml file](https://github.com/onweru/hugo-swift-theme/blob/master/exampleSite/data/authors.yml) from the `exampleSite` into your sites `./data` directory.
63
62
64
-
```yaml
65
-
- name: "yourName"# if fullName 👇🏻 isn't set, name will be displayed on author card
66
-
fullName: "John Doe"# optional. If set, it will display on author card
67
-
photo: "myAvatar.jpg"
68
-
url: "https://myURLofChoice.domain"
69
-
bio: "It's time to flex. Write a short or not-so-short summary about yourself."
63
+
```toml
64
+
[[params.authors]]
65
+
name = "yourName"# if fullName 👇🏻 isn't set, name will be displayed on author card
66
+
fullName = "Your Full Name"# optional. If set, it will display on author card
67
+
bio = "It's time to flex. Write a short or not-so-short summary about yourself."
68
+
photo = "myPhotoFile.jpg"
69
+
url = "https://myURLofChoice.domain"
70
70
```
71
71
72
72
2. Specify the name in your content files
@@ -80,7 +80,7 @@ To enable them, you may refer to the
80
80
81
81
Don't include an `author` in your article front matter.
82
82
83
-
The *authors.yml* file helps you:
83
+
The `[[.Params.authors]]` interface in the config.toml file helps you:
84
84
85
85
1. Write all your author information in one place. This way, you only specify the author name on your content files (posts). The rest of the data i.e photo, url & bio are automatically pulled from the data file.
86
86
@@ -107,7 +107,7 @@ This theme ships with two custom shortcodes (they both use positional parameters
107
107
108
108
1.__Video__
109
109
This shortcode can be used to embed a youtube video with custom styling. It takes a solo positional parameter.
110
-
110
+
111
111
```
112
112
...
113
113
{{< video "youtubeVideoID" >}}
@@ -117,19 +117,19 @@ This theme ships with two custom shortcodes (they both use positional parameters
117
117
2. __Picture__
118
118
You want to use darkmode images when darkmode is enabled on a device and a regular image on lightmode? It takes 3 positional parameters
119
119
120
-
Store these images in the `static/images` directory.
121
-
120
+
Store these images in the `static/images` directory.
121
+
122
122
```
123
123
...
124
124
{{< picture "lightModeImage.png" "darkModeImage.png" "Image alt text" >}}
125
125
...
126
126
```
127
127
128
128
3. __Gallery__
129
-
Include inline galleries within your articles. These galleries can contain `N` number of images. It takes 2 positional parameters.
130
-
129
+
Include inline galleries within your articles. These galleries can contain `N` number of images. It takes 2 positional parameters.
130
+
131
131
The 1st parameter is required. It's a _comma-separated list_ (`,`) of your images' paths.
132
-
132
+
133
133
The 2nd parameter is optional. It's a _double-collon-separated list_ (`::`) of your images' alt/description/captions text. It's always a good SEO practice to include alt text for your images.
0 commit comments