📓 Amethyst

Troubleshooting and FAQ

Still having trouble? Here are a list of common questions and problems people encounter when installing Amethyst.

Does Amethyst have Latex support? #

Yes! See LaTeX for a brief demo.

Can I use <Obsidian Plugin> in Amethyst? #

Unless it produces direct Markdown output in the file, no. There currently is no way to bundle plugin code with Amethyst.

The easiest way would be to add your own HTML partial that supports the functionality you are looking for.

My GitHub pages is just showing the README #

Make sure you set the source to deploy from the deploy branch (and not main) using / (root)! See more in the hosting guide

Some of my pages have ‘January 1, 0001’ as the last modified date #

This is a problem caused by git treating files as case-insensitive by default and some of your posts probably have capitalized file names. You can turn this off in your Amethyst by running this command.

# in the root folder (same folder as config.toml)
git config core.ignorecase true

# or globally (not recommended)
git config --global core.ignorecase true

Can I publish only a subset of my pages? #

Yes! Amethyst makes selective publishing really easy. Heres a guide on excluding pages from being published.

Can I host this myself and not on GitHub Pages? #

Yes! All built files can be found under /public in the master branch. More details under hosting.

command not found: hugo-obsidian #

Make sure you set your GOPATH correctly! This will allow your terminal to correctly recognize hugo-obsidian as an executable.

# Add the following 2 lines to your ~/.bash_profile
export GOPATH=/Users/$USER/go
export PATH=$GOPATH/bin:$PATH

# In your current terminal, to reload the session
source ~/.bash_profile

How come my notes aren’t being rendered? #

You probably forgot to include front matter in your Markdown files. You can either setup Obsidian to do this for you or you need to manually define it. More details in the ‘how to edit’ guide.

My custom domain isn’t working! #

Walk through the steps in the hosting guide again. Make sure you wait 30 min to 1 hour for changes to take effect.

How do I setup Google Analytics? #

You can edit it in config.toml and either use a V3 (UA-) or V4 (G-) tag.

How do I change the content on the home page? #

To edit the main home page, open /content/_index.md.

How do I change the colours? #

You can change the theme by editing assets/custom.scss. More details on customization and themeing can be found in the customization guide.

How do I add images? #

You can put images anywhere in the /content folder.

Example image (source is in content/setup/images/example.png)
![Example Image](/content/setup/images/example.png)

By default, the linkIndex.json (which Amethyst needs to generate the Interactive Graph and Backlinks) are not regenerated locally. To set that up, see the guide on local editing

Can I use React/Vue/some other framework? #

Not out of the box. You could probably make it work by editing /layouts/_default/single.html but that’s not what Amethyst is designed to work with. 99% of things you are trying to do with those frameworks you can accomplish perfectly fine using just vanilla HTML/CSS/JS.

Still Stuck? #

Amethyst isn’t perfect! If you’re still having troubles, file an issue in the GitHub repo with as much information as you can reasonably provide. Alternatively, send me a message using your preferred communication method!

🐛 Submit an Issue