https://github.com/jackyzha0/hugo-obsidian

simple GitHub action to parse Markdown Links into a .json file for Hugo
https://github.com/jackyzha0/hugo-obsidian

Last synced: 5 days ago
JSON representation

simple GitHub action to parse Markdown Links into a .json file for Hugo

• Host: GitHub
• URL: https://github.com/jackyzha0/hugo-obsidian
• Owner: jackyzha0
• License: mit
• Archived: true
• Created: 2021-07-17T04:54:35.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-12T05:26:40.000Z (12 months ago)
• Last Synced: 2024-06-18T22:57:34.251Z (8 days ago)
• Language: Go
• Homepage:
• Size: 47.9 KB
• Stars: 150
• Watchers: 4
• Forks: 67
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• jimsghstars - jackyzha0/hugo-obsidian - simple GitHub action to parse Markdown Links into a .json file for Hugo (Go)
• project-awesome - jackyzha0/hugo-obsidian - simple GitHub action to parse Markdown Links into a .json file for Hugo (Go)

README

        
# Obsidian Link Scraper

Used by [Quartz](https://github.com/jackyzha0/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](http://obsidian.md/) vault for links and exposes them as a `.json` file for easy consumption by [Hugo](https://gohugo.io/).

### 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`

```shell

# 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`)

```yaml

...

jobs:

  deploy:

    runs-on: ubuntu-18.04

    steps:

      - uses: actions/checkout@v2

      - name: Build Link Index

        uses: jackyzha0/[email protected]

        with:

          input: content # input folder

          output: data   # output folder

          index: true    # whether to index content

      ...

```