https://github.com/hackerkid/gogardener
Digital garden generator from markdown files
https://github.com/hackerkid/gogardener
Last synced: 8 months ago
JSON representation
Digital garden generator from markdown files
- Host: GitHub
- URL: https://github.com/hackerkid/gogardener
- Owner: hackerkid
- Created: 2020-07-14T17:18:00.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-08T21:03:14.000Z (almost 6 years ago)
- Last Synced: 2025-07-29T12:56:44.606Z (11 months ago)
- Language: Go
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌱 GoGardener [WIP]
A blazing fast cli for generating digital garden from markdown files. Supports markdown files exported from [Roam Research](https://roamresearch.com/), [Obsidian](https://obsidian.md/) etc.
Demo at https://vishnuks.com/garden/
## 🎉 Features
* Generates HTML pages from the markdown files.
* Supports backlinks.
* Supports tags (coming soon).
## 🛠️ Installation
```bash
git clone https://github.com/hackerkid/gogardener
cd gogardener
go install .
```
## ✍️ Usage
```
~/go/bin/gogardener --input markdown-files-dir --output output-dir --base-template base.html
```
* `input` - The directory containing your markdown files.
* `output` - The directory where the generated HTML files should be stored (⚠️ All the files in this directory would be removed.)
* `base-template` - The file that should be used as the base template for the HTML files. You can use the one included in the repo for starting up.
## 🚧 Todo
* Make tags work
* Make images work.