/neonote

Hugo Theme for Minimalists 🎨✒️

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

Neonote

License People Stars Forks Watches Last Updated

Hugo Theme for Minimalists 🎨✒️

neonote Demo
neonote screenshot

What is this

A minimalist theme for Hugo based on hugo-notepadium.

Inspiration

I needed a theme for my blog, that's all :)

Features

Difference from original notepadium theme

  • grid layout (Can I use grid?)
  • tags cloud
  • toc
  • preconnect and prefetch for resourses
  • inline critical css
  • hugo modules
  • archive page
  • light & dark theme toggle button
  • search in site (powered by stork)
  • more useful Hugo shortcodes
    • tips blocks(alert messages)
    • plist for simple table in markdown

Other features

  • Logo
  • Navigation items
  • Syntax highlighting
  • Math supporting
  • Pagination with large number of pages supporting
  • Light & Dark
  • Custom CSS supporting
  • Custom JS supporting
  • Custom header right items supporting

Get started

There are two ways to use this theme for Hugo site.

Option 1

Use Hugo modules. Hugo Modules is powered by Go Modules. If you have installed Go, this option is recommended. More details can be found in Hugo Docs

  1. Initialize the hugo module system in your site root:
hugo mod init github.com/<your_user>/<your_project>
  1. Import the theme in your config.toml:
[module]
  [[module.imports]]
    path = "github.com/2kabhishek/neonote"

Option 2

Use git submodule.

  1. Add theme repository as git submodule
git submodule add https://github.com/2kabhishek/neonote.git themes/neonote
  1. Set theme in your config.toml
theme = "neonote"

Configure theme

Almost everything can be configured in the config.toml file of your site. If you want to modify the theme, you could go to Customize theme

Check the example-config.toml or config.toml file for more details.

Update theme

If you installed the theme by Hugo module

hugo mod get -u  # This will update all modules
hugo mod get -u github.com/2kabhishek/neonote  # This will update current theme

If you installed the theme by git submodule, first go to the theme directory, then git pull

cd themes/neonote && git pull

More Info

Source | Website