Hugo Obsidian

Overview

The Obsidian Link Scraper is a tool used by Quartz that helps in scraping links from an Obsidian vault and exposes them as a .json file for easy consumption by Hugo. It consists of two main parts - a GitHub Action that scrapes the links into a .json file and a Hugo Partial that converts the .json file into graphs and tables. This repository is designed to streamline the process of creating link indexes in Hugo using data from Obsidian.

Features

• GitHub Action: The GitHub Action provided by the Obsidian Link Scraper allows users to scrape links from an Obsidian vault and save them as a .json file.
• Hugo Partial: The Hugo Partial included in this repository helps in converting the .json file generated by the GitHub Action into graphs and tables in Hugo.
• Binary Usage: Users can use the provided binary to read Markdown files from the /content folder and generate the linkIndex.json file, which can be placed in the /data folder.
• GitHub Action Usage: To use the GitHub Action, users can simply add the 'Build Link Index' step in their workflow file.

Summary

The Obsidian Link Scraper is a handy tool for scraping links from an Obsidian vault and generating a .json file that can be easily used in Hugo. With its GitHub Action and Hugo Partial, it offers a streamlined way to create link indexes in Hugo using data from Obsidian. Overall, this tool simplifies the process of managing and displaying links in a Hugo website.