diff --git a/README.md b/README.md index 0342543..79d7943 100644 --- a/README.md +++ b/README.md @@ -1,7 +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/). +This repository comes to you in two parts. -## Example Usage (Binary) +1. GitHub Action (scrapes links into a `.yml` file) +2. Hugo Partial (turns `.yml` 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 `.yml` file for easy consumption by [Hugo](https://gohugo.io/). +### Example Usage (Binary) Read Markdown from the `/content` folder and place the resulting `linkIndex.yaml` into `/data` ```shell @@ -12,4 +17,27 @@ go install github.com/jackyzha0/hugo-obsidian hugo-obsidian -input=content -output=data ``` -## Example Usage (GitHub Action) +### Example Usage (GitHub Action) + + + +## Hugo Partial + + +### Configuration +```yaml +enableLegend: false +enableDrag: true +enableZoom: false +base: + node: "#284b63" + activeNode: "#f28482" + inactiveNode: "#a8b3bd" + hoverNode: "#afbfc9" + link: "#aeb4b8" + activeLink: "#5a7282" +paths: + - /toc: "#4388cc" + - /newsletters: "#e0b152" + - /posts: "#42c988" +``` \ No newline at end of file diff --git a/example_graphConfig.yaml b/example_graphConfig.yaml new file mode 100644 index 0000000..adb9c6e --- /dev/null +++ b/example_graphConfig.yaml @@ -0,0 +1,14 @@ +enableLegend: false +enableDrag: true +enableZoom: false +base: + node: "#284b63" + activeNode: "#f28482" + inactiveNode: "#a8b3bd" + hoverNode: "#afbfc9" + link: "#aeb4b8" + activeLink: "#5a7282" +paths: + - /toc: "#4388cc" + - /newsletters: "#e0b152" + - /posts: "#42c988" \ No newline at end of file