Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saadjsct/npqhugo
npq-hugo is a customizable and responsive dark blog theme with integrated contact form and code syntax highlighting
https://github.com/saadjsct/npqhugo
hugo hugo-theme
Last synced: 3 months ago
JSON representation
npq-hugo is a customizable and responsive dark blog theme with integrated contact form and code syntax highlighting
- Host: GitHub
- URL: https://github.com/saadjsct/npqhugo
- Owner: saadjsct
- License: gpl-3.0
- Created: 2020-04-11T11:27:48.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-27T22:53:25.000Z (over 1 year ago)
- Last Synced: 2024-06-21T15:06:25.797Z (5 months ago)
- Topics: hugo, hugo-theme
- Language: CSS
- Homepage:
- Size: 204 KB
- Stars: 28
- Watchers: 2
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - saadjsct/npqhugo - npq-hugo is a customizable and responsive dark blog theme with integrated contact form and code syntax highlighting (others)
README
# npq hugo theme
## demo
[here](https://themes.gohugo.io/theme/npq-hugo/) is a live demo you can see
## main features
- dark
- responsive
- out of the box contact form
- avatar support
- syntax highlighting
- table of content
- customizable
## installation
after you have installed hugo (see [quick start](https://gohugo.io/getting-started/quick-start/)) clone this repo in your site's theme directory to install the theme. then use the example configuration provided as a reference to get started.
## configuration
this is how your config.toml will look like after installation, change the values according to your site.
```toml
baseURL = "https://www.example.com"
languageCode = "en-us"
title = "title"
copyright = "Copyright © 2008–2019, Steve Francia and the Hugo Authors; all rights reserved."
theme = "npq-hugo"
pygmentsUseClasses=true
[params]
author = "your name"
description = "your description"
keywords = "hugo blog"
useAvatar = true
microBlogSection = "posts"
displayMicroBlog = true
displayRecent = true
recentMax = 4
mail = "[email protected]"
phone = "8888888888"
formspreeID = "yourformspreeID"
[menu]
[[menu.main]]
name = "home"
pre = ""
url = "/"
weight = -9
[[menu.main]]
name = "blog"
pre = ""
url = "/blog/"
weight = -8
[[menu.main]]
name = "tags"
pre = ""
url = "/tags"
weight = -7
[[menu.main]]
name = "github"
pre = ""
url = "https://github.com/yourgithubusername23434"
weight = -6
[[menu.main]]
name = "RSS"
pre = ""
url = "/index.xml"
weight = -4
[[menu.main]]
name = "contact"
pre = ""
url = "/contact"
weight = -1
```
for the contact page to work you have to make a free form at [formspree](https://formspree.io/) and put your form id in the variable `formspreeID` in the configuration file.
every menu entry has a corresponding section named `[[menu.mail]]` under `[menu]`. to add or change a menu entry add or change the corresponding section with `name` being the name displayed in the menu, `pre` is a text before the name (you can grap icons from [fontawesome](https://fontawesome.com/)), `url` is the url that the menu item points to, and weight is an integer value that represent the order of the menu items (items with lower weight float)
In order to see your site updating while changing it, run Hugo's built-in local server.
```sh
hugo server
```
### micro blog
posts in the directory "posts" (can be configured) in the contents directory will be displayed under the microblog section on the home page. if you want to pin a post to the top put `pinned: true` in the post's front matter.
example front matter:
```
---
pinned: true
date: 2020-04-09T00:16:00+02:00
---
```
## License
GPLv3