Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/kimcc/hugo-theme-noteworthy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
index d4e0770..8c515c8 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,28 @@ 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 thist:
+
+```
+{{< 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" >}}
+```
## Social media accounts
@@ -77,6 +99,17 @@ disqusShortname = ""
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