Go to file
2023-03-16 10:29:45 -07:00
.gitignore basic dir walking + link parsing 2021-07-16 23:26:40 -04:00
action.yml add root flag 2022-02-28 07:23:11 -08:00
Dockerfile add tags support 2023-03-16 10:25:45 -07:00
go.mod fix: broken front matter parsing 2022-05-05 00:55:59 -04:00
go.sum fix: broken front matter parsing 2022-05-05 00:55:59 -04:00
LICENSE.txt basic dir walking + link parsing 2021-07-16 23:26:40 -04:00
main.go fix: draft links being added, linkmap writer 2022-07-31 09:46:39 -07:00
parse.go fix "footnotes as node" 2022-10-15 20:09:25 +08:00
README.md Fix typo in README title 2022-09-18 23:45:21 -04:00
util.go Fix wikilink processing bug 2022-08-23 23:27:12 -05:00
walk.go default tags 2023-03-16 10:29:45 -07:00
write.go fix: linkmap should not include index portion of uri 2022-07-31 16:49:52 -07:00

Obsidian Link Scraper

Used by Quartz

This repository comes to you in two parts.

  1. GitHub Action (scrapes links into a .json file)
  2. Hugo Partial (turns .json file into graphs and tables)

GitHub Action

GitHub action and binary to scrape Obsidian vault for links and exposes them as a .json file for easy consumption by Hugo.

Example Usage (Binary)

Read Markdown from the /content folder and place the resulting linkIndex.json (and contentIndex.yaml if the index flag is enabled) into /data

# Installation
go install github.com/jackyzha0/hugo-obsidian@latest

# Run
hugo-obsidian -input=content -output=data -index=true

Example Usage (GitHub Action)

Add '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
      ...