Search
Getting Started # Setting up Amethyst requires a basic understanding of git. If you are unfamiliar, this resource is a great place to start! Forking # A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. Navigate to the GitHub repository for the Amethyst project: 📁 Amethyst Repository Then, Fork the repository into your own GitHub account. ...
Editing # Amethyst runs on top of Hugo so all notes are written in Markdown. Folder Structure # Here’s a rough overview of what’s what. All notes you want to publish should go in the /content folder. To make edits, you can open any of the files and make changes directly and save it. You can organize content into any subfolder you’d like. To edit the main home page, open /content/_index. ...
Setup # Obsidian is the preferred way to use Amethyst. You can either create a new Obsidian Vault or link one that your already have. New Vault # If you don’t have an existing Vault, download Obsidian and create a new Vault in the /content folder that you created and cloned during the setup step. Linking an existing Vault (simple) # The easiest way to use an existing Vault is to copy all of your files (directory and hierarchies intact) into the /content folder. ...
If you’d like to preview what your site looks like before deploying it to the internet, the following instructions guide you through installing the proper dependencies to run it locally. Install hugo-obsidian # This step will generate the list of backlinks for Hugo to parse. Ensure you have Go (>= 1.16) installed. # Install and link `hugo-obsidian` locally go install github.com/jackyzha0/hugo-obsidian@latest If you are running into an error saying that command not found: hugo-obsidian, make sure you set your GOPATH correctly! ...
Configuration # Amethyst is designed to be extremely configurable. You can find the bulk of the configuration scattered throughout the repository depending on how in-depth you’d like to get. The majority of configuration can be found under config.yaml. An example, with descriptions for each setting, can be found here. Code Block Titles # To add code block titles with Amethyst: Ensure that code block titles are enabled in the configuration: ...
Hosting on GitHub Pages # Amethyst is designed to be effortless to deploy. If you forked and cloned Amethyst directly from the repository, everything should already be good to go! Follow the steps below. Enable GitHub Actions # By default, GitHub disables workflows from running automatically on Forked Repostories. Head to the ‘Actions’ tab of your forked repository and Enable Workflows to setup deploying your site! Enable GitHub Actions ...