adds headshot resource support
This commit is contained in:
41
README.md
41
README.md
@ -8,6 +8,47 @@ Developed in Hugo.
|
||||
|
||||
Navigate to the project directory and:
|
||||
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
Then, to serve the site locally:
|
||||
|
||||
```
|
||||
hugo server
|
||||
```
|
||||
|
||||
## Articles
|
||||
|
||||
see `/archetypes/article.md` for the article template. You can create a new article with:
|
||||
|
||||
```
|
||||
hugo new articles/2023-01-01-my-new-article.md
|
||||
```
|
||||
This will create a new article in the `content/articles` directory with the current date and the title you provide. You can then edit the file to add your content.
|
||||
|
||||
### Head shots
|
||||
|
||||
Optionally you can add a headshot photo to your article. To do this:
|
||||
|
||||
1. Place your image file in the `/assets/headshots/` directory
|
||||
2. Add a `headshot` field to your article's front matter with just the filename. For example:
|
||||
|
||||
```yaml
|
||||
headshot: "firstname-lastname.jpg"
|
||||
```
|
||||
|
||||
*Note: Name is case sensitive, might as well use lowercase letters and hyphens in your filename.*
|
||||
|
||||
### Narrator links
|
||||
|
||||
You can add links to an article that relate to the narrator. To do this, add a `links` field to the front matter of the article. The value should be a list of objects, each with a `text` and `url` field. For example:
|
||||
|
||||
```
|
||||
links:
|
||||
- text: "My Website"
|
||||
url: "https://example.com"
|
||||
- text: "My Twitter"
|
||||
url: "https://twitter.com/example"
|
||||
```
|
||||
This will include the links in the article page. The links will be displayed as a list with the text as the link text and the URL as the link target.
|
Reference in New Issue
Block a user