Skip to content

Commit cff9825

Browse files
author
weru
committed
update docs
1 parent eea6ff9 commit cff9825

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,11 @@ You can configure the site using as follows:
4242
Use the file `config.toml`.
4343
2. ### menu, footer
4444

45-
See the **data** files inside the `data/` directory.
45+
See the **config.toml** file's menu areas.
4646

4747
> Follow the `exampleSite/`.
4848
3. Customize Theme colors
4949
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-
5150

5251
## Staticman Comments
5352

@@ -61,12 +60,13 @@ To enable them, you may refer to the
6160

6261
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.
6362

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"
7070
```
7171

7272
2. Specify the name in your content files
@@ -80,7 +80,7 @@ To enable them, you may refer to the
8080

8181
Don't include an `author` in your article front matter.
8282

83-
The *authors.yml* file helps you:
83+
The `[[.Params.authors]]` interface in the config.toml file helps you:
8484

8585
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.
8686

@@ -107,7 +107,7 @@ This theme ships with two custom shortcodes (they both use positional parameters
107107

108108
1. __Video__
109109
This shortcode can be used to embed a youtube video with custom styling. It takes a solo positional parameter.
110-
110+
111111
```
112112
...
113113
{{< video "youtubeVideoID" >}}
@@ -117,19 +117,19 @@ This theme ships with two custom shortcodes (they both use positional parameters
117117
2. __Picture__
118118
You want to use darkmode images when darkmode is enabled on a device and a regular image on lightmode? It takes 3 positional parameters
119119
120-
Store these images in the `static/images` directory.
121-
120+
Store these images in the `static/images` directory.
121+
122122
```
123123
...
124124
{{< picture "lightModeImage.png" "darkModeImage.png" "Image alt text" >}}
125125
...
126126
```
127127
128128
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+
131131
The 1st parameter is required. It's a _comma-separated list_ (`,`) of your images' paths.
132-
132+
133133
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.
134134
135135
```

0 commit comments

Comments
 (0)