obsidian-garden
Transform Obsidian Vault's notes into web pages. Converts your markdown notes, created in Obsidian, into fully functional site, ready for deployment.
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- release.yaml
- test.yaml
- Page Name.md
- .gitignore
- example.md
- Markdown.md
- Page Name.md
- pagefind.yaml
- WikiLink.md
- main.rs
- metadata.rs
- note.rs
- site.rs
- vault.rs
- wikilink.rs
- out.js
- script.js
- style.css
- aside.html
- base.html
- menu.html
- page.html
- search_form.html
- sidebar.html
- .gitignore
- Cargo.toml
- install.sh
- LICENSE
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/ecarrara/obsidian-garden
Downloads the entire project code from GitHub to your computer.
cd obsidian-garden
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommendedcurl https://raw.githubusercontent.com/ecarrara/obsidian-garden/main/install.sh | sh
Downloads and runs the official install script in one line โ this handles the full setup automatically.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)