mirror of
https://github.com/thomasjsn/hugo-theme-hello-friend.git
synced 2024-11-21 23:35:08 +01:00
merge master
This commit is contained in:
commit
fa979be419
20
README.md
20
README.md
@ -19,6 +19,7 @@ This theme is pretty basic and covers all of the essentials. All you have to do
|
||||
- [How to configure](#how-to-configure)
|
||||
- [How to add a cover image to your posts](#how-to-add-a-cover-image-to-your-posts)
|
||||
- [How to display the Last Modified Date in your posts](#how-to-display-the-last-modified-date-in-your-posts)
|
||||
- [How to hide "Read more" button](#how-to-hide-%22read-more%22-button)
|
||||
- [Add-ons](#add-ons)
|
||||
- [How to run your site](#how-to-run-your-site)
|
||||
- [How to edit the theme](#how-to-edit-the-theme)
|
||||
@ -62,13 +63,13 @@ You can download the theme manually by going to [https://github.com/panr/hugo-th
|
||||
|
||||
You can also clone it directly to your Hugo folder:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ git clone https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend
|
||||
```
|
||||
|
||||
If you don't want to make any radical changes, it's the best option, because you can get new updates when they are available. To do so, include it as a git submodule:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ git submodule add https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend
|
||||
```
|
||||
|
||||
@ -76,7 +77,7 @@ $ git submodule add https://github.com/panr/hugo-theme-hello-friend.git themes/h
|
||||
|
||||
The theme doesn't require any advanced configuration. Just copy:
|
||||
|
||||
```
|
||||
```toml
|
||||
baseurl = "/"
|
||||
languageCode = "en-us"
|
||||
theme = "hello-friend"
|
||||
@ -85,10 +86,13 @@ paginate = 5
|
||||
[params]
|
||||
# dir name of your blog content (default is `content/posts`)
|
||||
contentTypeName = "posts"
|
||||
|
||||
# "light" or "dark"
|
||||
defaultTheme = "dark"
|
||||
|
||||
# if you set this to 0, only submenu trigger will be visible
|
||||
showMenuItems = 2
|
||||
|
||||
# Show reading time in minutes for posts
|
||||
showReadingTime = false
|
||||
|
||||
@ -150,6 +154,10 @@ Example: `lastModDisplay = "Modified:"` --> "Modified: Jan 01, 0001"
|
||||
|
||||
:octocat: Hugo's `enableGitInfo` option is a nice complement to this feature.
|
||||
|
||||
## How to hide "Read more" button
|
||||
|
||||
In a post's front matter you have to add `hideReadMore` param set to `true`. This will result in that the post won't have "Read more" button in the list view.
|
||||
|
||||
## Add-ons
|
||||
|
||||
- **Archive** — Theme has built-in `archive` page for main content (see `contentTypeName` variable in config). If you need archive on your blog just copy https://github.com/panr/hugo-theme-hello-friend/blob/master/exampleSite/content/archive.md to your `content` dir. If you need multilangual archives, duplicate `content/archive.md` and add `.Lang` variable, eg: `content/archive.pl.md` (remember to change `url` in duplicated file).
|
||||
@ -162,7 +170,7 @@ Example: `lastModDisplay = "Modified:"` --> "Modified: Jan 01, 0001"
|
||||
|
||||
From your Hugo root directory run:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ hugo server -t hello-friend
|
||||
```
|
||||
|
||||
@ -174,13 +182,13 @@ If you have to override some of the styles, you can do this easily by adding `st
|
||||
|
||||
Otherwise, if you really want to edit the theme, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory):
|
||||
|
||||
```
|
||||
```bash
|
||||
$ cd themes/hello-friend
|
||||
```
|
||||
|
||||
and then run:
|
||||
|
||||
```
|
||||
```bash
|
||||
$ npm install
|
||||
$ npm i yarn
|
||||
$ yarn
|
||||
|
@ -53,7 +53,9 @@
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
</div>
|
||||
<div><a class="read-more button" href="{{.RelPermalink}}">{{ $.Site.Params.ReadMore | default "Read more" }} →</a></div>
|
||||
{{ if not .Params.hideReadMore }}
|
||||
<div><a class="read-more button" href="{{.RelPermalink}}">{{ $.Site.Params.ReadMore | default "Read more" }} →</a></div>
|
||||
{{ end }}
|
||||
</div>
|
||||
{{ end }}
|
||||
{{ partial "pagination.html" . }}
|
||||
|
Loading…
Reference in New Issue
Block a user