Used by Quartz
This repository comes to you in two parts.
- GitHub Action (scrapes links into a
.ymlfile) - Hugo Partial (turns
.ymlfile into graphs and tables)
GitHub action and binary to scrape Obsidian vault for links and exposes them as a .yml file for easy consumption by Hugo.
Read Markdown from the /content folder and place the resulting linkIndex.yaml (and contentIndex.yaml if the index flag is enabled) into /data
# Installation
go install github.com/jackyzha0/hugo-obsidian
# Run
hugo-obsidian -input=content -output=data -index=trueAdd 'Build Link Index' as a build step in your workflow file (e.g. .github/workflows/deploy.yaml)
...
jobs:
deploy:
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@v2
- name: Build Link Index
uses: jackyzha0/hugo-obsidian@v2.1
with:
input: content # input folder
output: data # output folder
index: true # whether to index content
...