OpenSourceArk/hugo-obsidian
1
0
Fork 0
mirror of https://github.com/jackyzha0/hugo-obsidian.git synced 2024-06-14 11:42:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

basic readme

Browse Source
This commit is contained in:
jackyzha0 2021-07-17 01:06:39 -04:00
parent 4e570482e9
commit 6709f7ce99
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md Normal file
View File

@ -0,0 +1,12 @@
# Obsidian Link Scrapper
GitHub action and binary to scrape [Obsidian](http://obsidian.md/) vault for links and exposes them as a `.yml` file for easy consumption by [Hugo](https://gohugo.io/).
## Installation
`go install github.com/jackyzha0/hugo-obsidian`
### Example Usage
Read Markdown from the `/content` folder and place the resulting `linkIndex.yaml` into `/data`
```shell
hugo-obsidian -input=content -output=data
```