blob: 7eb31dabc934a80d4b8e4c88f0aca3352daf649a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
# Noteworthy
Noteworthy is a minimalist Hugo theme for writers and bloggers.
## Features
* Fully responsive
* Google Analytics and Disqus integration
* Ko-fi donation button
* Syntax highlighting
* Mathematical notations with KaTex
* About, Tags, and Archives pages
* RSS feeds
* Social media links
* SCSS for styling
## Installation
Navigate to the root directory of your Hugo site and clone this repository.
```
git clone https://github.com/kimcc/hugo-theme-noteworthy.git themes/noteworthy
```
Refer to the [Hugo docs](https://gohugo.io/getting-started/quick-start/) for more information.
## Image shortcode for large images
To add images using the resize-image shortcode included with this theme, you will need to create a [Post Bundle](https://gohugo.io/content-management/organization/#page-bundles). Create a folder for your post, put your Markdown file and images inside, and rename your Markdown file `index.md`. For example:
```
my-new-post
- index.md
- image1.jpg
- image2.png
```
Then, you can add an image within your Markdown file by using the shortcode like this:
```
{{< resize-image src="image1.jpg" alt="My first image" >}}
```
Add captions like this:
```
{{< resize-image src="image2.png" alt="My second image" caption="My caption" >}}
```
## Read more link for posts
Set `showReadMore = false` to `true` in the config file to have a "read more" link show up when posts are truncated.
## Social media accounts
In the `params` section of the `config.toml` file, you can add links to your social media accounts. Simply remove the ones that you don't want to include, and their icons will disappear from the site.
```
# Main
email = "#"
facebook = "#"
twitter = "#"
instagram = "#"
tumblr = "#"
reddit = "#"
pinterest = "#"
youtube = "#"
vimeo = "#"
weibo = "#"
vk = "#"
linkedin = "#"
# Writing
medium = "#"
blogger = "#"
wordpress = "#"
# Creative & Visual
dribbble = "#"
behance = "#"
deviantart = "#"
flickr = "#"
# Audio & Music
soundcloud = "#"
# Programming
github = "#"
stackoverflow = "#"
gitlab = "#"
codepen = "#"
# Academic
googlescholar = "#"
impactstory = "#"
orcid = "#"
```
## Disqus and Google Analytics
Add your Disqus shortname and Google Analytics identifier in the `config.toml` file.
```
# Add your Disqus shortname here.
disqusShortname = ""
# Add your Google Analytics identifier: UA-XXXXXXXX-X
googleAnalytics = ""
```
## Ko-fi donation button
If you'd like to enable a Ko-fi button on your posts, enable it in the config file and add your identifier.
```
# Set enableKofi to true to enable the Ko-fi support button. Add your Ko-fi ID to link to your account.
enableKofi = true
kofi = ""
```
## License
Released under the [MIT License](https://github.com/kimcc/hugo-theme-noteworthy/blob/master/LICENSE.md).
|
