update metadata

README.md

@@ -3,20 +3,33 @@
 [![Hugo](https://img.shields.io/badge/hugo-0.96-blue.svg)](https://gohugo.io)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
-Amethyst combines the navigational features of [hugo-book](https://github.com/alex-shpak/hugo-book) with the Obsidian integrations of [quartz](https://github.com/jackyzha0/quartz) to provide a hassle-free place to store and host personal notes or documentation.
 
-![amethyst screenshot](content/setup/images/amethyst-screenshot.png)
+
+![amethyst screenshot](images/screenshot.png)
+
+## Why Amethyst?
+I write most of my [notes](https://notes.bencuan.me) in [Obsidian](https://obsidian.md/). When trying to find a suitable open-source alternative for Obsidian Publish, I couldn't find exactly what I was looking for: a simple, customizable theme with sidebar navigation that supported Obsidian features (like backlinks or LaTeX) in such a way that didn't require me to reformat my notes.
+
+Amethyst is an attempt to deliver this by combining the navigational features of [hugo-book](https://github.com/alex-shpak/hugo-book) with the Obsidian integrations of [quartz](https://github.com/jackyzha0/quartz) to provide a hassle-free place to store and host personal notes or documentation.
 
 ## Features
-- Most of the features of the original themes (Quartz and Book)
-- Mobile-friendly
-- Multi-language support
-- Customizable
-- Dark Mode
-- LaTeX support
-- Obsidian-style back/forward links and page previews
-- Interactive graph view
-- Tab cards for practice problems
+
+Amethyst preserves most of the features of quartz and hugo-book, including:
+ - Navigation sidebars on 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
+
+Some new features that were added on top:
+ - 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 config
+ - Support for both absolute and relative links, Obsidian-style
 
 ## Documentation
 If you just want to use Amethyst for your own notes hosting, go to [amethyst.bencuan.me](https://amethyst.bencuan.me) for a demo and documentation on how to use it.

config.toml

@@ -0,0 +1,4 @@
+[module]
+  [module.hugoVersion]
+    extended = true
+    min = "0.93.0"

content/setup/search.md

@@ -7,7 +7,7 @@ Amethyst supports two modes of searching through content.
 ## Full-text
 Full-text search is the default in Amethyst. It produces results that *exactly* match the search query. This is easier to setup but usually produces lower quality matches.
 
-```yaml {title="data/config.yaml"}
+```yaml {title="config.yaml"}
 # the default option
 enableSemanticSearch: false
 ```
@@ -24,9 +24,9 @@ Here's how to set it up.
 3. Click into the index you've created. Under "Index Something", select "SITEMAP" from the dropdown and click "Add Source".
 4. For the "Sitemap.xml URL", put your deployed site's base URL followed by `sitemap.xml`. For example, for `amethyst.bencuan.me`, put `https://amethyst.bencuan.me/sitemap.xml`. Leave the URL Regex empty. 
 5. Get your API key. On the dashboard, under "API Keys", you can manage your API keys. If you don't already have an API key, click "Create API Key". You'll need this for the next step.
-6. Open `data/config.yaml`. Set `enableSemanticSearch` to `true`, `operandApiKey` to your copied key, and `operandIndexId` to the ID of the index we created from earlier..
+6. Open `config.yaml`. Set `enableSemanticSearch` to `true`, `operandApiKey` to your copied key, and `operandIndexId` to the ID of the index we created from earlier..
 
-```yaml {title="data/config.yaml"}
+```yaml {title="config.yaml"}
 # the default option
 search:
   enableSemanticSearch: true

theme.toml

@@ -6,8 +6,8 @@ license = "MIT"
 licenselink = "https://github.com/64bitpandas/amethyst/blob/main/LICENSE"
 description = "Obsidian-compatible Hugo theme for personal notes"
 homepage = "https://github.com/64bitpandas/amethyst"
-demosite = "https://notes.bencuan.me"
-tags = ["responsive", "notes", "obsidian", "obsidian-md", "latex", "documentation", "docs", "flexbox", "search", "mobile", "multilingual"]
+demosite = "https://amethyst.bencuan.me"
+tags = ["responsive", "notes", "obsidian", "obsidian-md", "latex", "documentation", "docs", "flexbox", "search", "mobile", "multilingual", "graph"]
 features = []
 min_version = "0.93"