Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 1.25 KB

README.md

File metadata and controls

57 lines (42 loc) · 1.25 KB
Raw

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:

curl https://raw.githubusercontent.com/ecarrara/obsidian-garden/main/install.sh | sh

Features

  • Generate fully static HTML files - SEO friendly and easy to deploy
  • Full-text search with pagefind
  • Math expressions with KaTeX
  • Table of contents
  • Excalidraw support

Getting Started

  1. Navigate to you Vault folder and run obsidian-garden init
cd my-notes/
obsidian-garden init
  1. Customize your site settings by editing the .garden/site.yaml file
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
  1. Generate a static site from your notes.
obsidian-garden build
  1. Optional - Enable pagefind on .garden/site.yaml and run pagefind to index your site
pagefind --source dist