https://github.com/ecarrara/obsidian-garden
Transform Obsidian Vault's notes into web pages. Converts your markdown notes, created in Obsidian, into fully functional site, ready for deployment.
https://github.com/ecarrara/obsidian-garden
digital-garden hacktoberfest markdown-notes obsidian obsidian-publish static-site-generator
Last synced: 5 months ago
JSON representation
Transform Obsidian Vault's notes into web pages. Converts your markdown notes, created in Obsidian, into fully functional site, ready for deployment.
- Host: GitHub
- URL: https://github.com/ecarrara/obsidian-garden
- Owner: ecarrara
- License: mit
- Created: 2023-07-25T02:19:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-21T22:13:18.000Z (about 1 year ago)
- Last Synced: 2024-08-13T07:15:44.802Z (8 months ago)
- Topics: digital-garden, hacktoberfest, markdown-notes, obsidian, obsidian-publish, static-site-generator
- Language: Rust
- Homepage:
- Size: 56.6 KB
- Stars: 95
- Watchers: 3
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - ecarrara/obsidian-garden - Transform Obsidian Vault's notes into web pages. Converts your markdown notes, created in Obsidian, into fully functional site, ready for deployment. (Rust)
README
# Obsidian Garden
Obsidian Garden is a program to transform Obsidian Vault's notes into web
pages. It converts your markdown notes, created in Obsidian, into fully
functional site, ready for deployment.## Installation
If you are on OS X or Linux, you can use the installation script to fetch the
latest release:```bash
curl https://raw.githubusercontent.com/ecarrara/obsidian-garden/main/install.sh | sh
```## Features
- [x] Generate fully static HTML files - SEO friendly and easy to deploy
- [x] Full-text search with [pagefind](https://pagefind.app/)
- [x] Math expressions with [KaTeX](https://katex.org/)
- [x] Table of contents
- [ ] Excalidraw support## Getting Started
1. Navigate to you Vault folder and run `obsidian-garden init`
```bash
cd my-notes/
obsidian-garden init
```2. Customize your site settings by editing the `.garden/site.yaml` file
```yaml
title: Site name
pagefind: false
topnav:
links:
- text: Link 1
href: https://example.com/link-1
- text: Link 2
href: https://example.com/link-2
```3. Generate a static site from your notes.
```bash
obsidian-garden build
```4. Optional - Enable pagefind on `.garden/site.yaml` and run
[pagefind](https://pagefind.app) to index your site```bash
pagefind --source dist
```