Amethyst

screenshot of Amethyst
hugo

Amethyst

📓 obsidian-compatible notes theme for hugo, built from quartz and hugo-book

Overview

Amethyst Hugo Theme is a customizable theme designed for storing and hosting personal notes or documentation. It aims to provide a simple and customizable theme with sidebar navigation that supports Obsidian features like backlinks and LaTeX without requiring reformatting of notes. The theme combines the navigational features of Hugo-Book with the Obsidian integrations of Quartz to deliver a hassle-free solution.

Features

  • Navigation sidebars on the left and right of content
  • Obsidian-style callouts
  • Interactive graph view
  • MermaidJS charts
  • User-togglable dark mode
  • Search bar
  • Multi-language support
  • Mobile support
  • Obsidian-style back/forward links and page previews
  • Custom formatting of tabs, sections, and expands specifically for Q&A-style interaction
  • Easy customization of theme colors and fonts
  • LaTeX enabled out of the box with no additional configuration
  • Support for both absolute and relative links, Obsidian-style

Installation

To use the Amethyst Hugo Theme, you need to meet the following requirements:

  • Go 1.16 or higher
  • Hugo 0.93 or higher

If you're using Ubuntu/Debian-based systems, you may need to install a higher version of Hugo from the releases page instead of using apt.

Next, install Hugo-Obsidian by running the command: go install github.com/jackyzha0/hugo-obsidian@latest

Make sure your PATH is properly configured so that binaries in the GOPATH can be executed.

To start the live server, run make serve. The content will be served to localhost:1313 by default. Note that you will need to restart the server to see changes to navigation.

Summary

Amethyst Hugo Theme is a customizable theme designed for storing and hosting personal notes or documentation. It combines the navigational features of Hugo-Book with the Obsidian integrations of Quartz to provide a hassle-free solution for users. The theme includes various features such as navigation sidebars, Obsidian-style callouts, interactive graph view, MermaidJS charts, dark mode, search bar, multi-language support, and more. Installation of the theme requires meeting certain requirements and following specific instructions.

hugo
Hugo

Hugo is an open-source static site generator that features fast build times, flexible themes, support for multiple content formats, multilingual websites, live reloading, and an active community. It allows developers to easily create and deploy SEO-friendly and mobile-responsive websites.