83 lines
1.6 KiB
Markdown
83 lines
1.6 KiB
Markdown
# Noteworthy
|
|
|
|
Noteworthy is a minimalist Hugo theme for writers and bloggers.
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
* Fully responsive
|
|
* Google Analytics and Disqus integration
|
|
* 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.
|
|
|
|
|
|
## 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 = "#"
|
|
weibo = "#"
|
|
vk = "#"
|
|
linkedin = "#"
|
|
|
|
# Writing
|
|
medium = "#"
|
|
blogger = "#"
|
|
wordpress = "#"
|
|
|
|
# Creative & Visual
|
|
dribbble = "#"
|
|
behance = "#"
|
|
deviantart = "#"
|
|
flickr = "#"
|
|
|
|
# Programming
|
|
github = "#"
|
|
stackoverflow = "#"
|
|
gitlab = "#"
|
|
codepen = "#"
|
|
```
|
|
|
|
|
|
## 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 = ""
|
|
```
|
|
|
|
|
|
## License
|
|
|
|
Released under the [MIT License](https://github.com/kimcc/hugo-theme-noteworthy/blob/master/LICENSE.md). |