Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kimcc/hugo-theme-noteworthy
A minimalist Hugo theme for writers and bloggers
https://github.com/kimcc/hugo-theme-noteworthy
blog blog-theme hugo hugo-theme static-site
Last synced: about 1 month ago
JSON representation
A minimalist Hugo theme for writers and bloggers
- Host: GitHub
- URL: https://github.com/kimcc/hugo-theme-noteworthy
- Owner: kimcc
- License: mit
- Created: 2020-02-02T17:12:38.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T09:40:56.000Z (3 months ago)
- Last Synced: 2024-09-28T05:41:10.481Z (about 2 months ago)
- Topics: blog, blog-theme, hugo, hugo-theme, static-site
- Language: HTML
- Homepage: https://themes.gohugo.io/theme/hugo-theme-noteworthy/
- Size: 2.82 MB
- Stars: 215
- Watchers: 7
- Forks: 109
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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 = "#"
# Travel
googlemaps = "#"
tripadvisor = "#"
```
## 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).