Expand description
obsidian-parser - Blazingly fast Rust library for parsing and analyzing Obsidian vaults
Provides idiomatic APIs for:
- Parsing individual Obsidian notes with frontmatter properties
- Analyzing entire vaults as knowledge graphs
- Extracting semantic relationships between notes
§Key Features
- ⚡ High Performance: Parses 1000+ notes in under 3ms
- 🧠 Knowledge Graphs: Built-in integration with
petgraphfor advanced analysis - 🧩 Flexible API: Supports both in-memory and on-disk note representations
- 🔍 Frontmatter Parsing: Extract YAML properties with
serdecompatibility - 🌐 Link Analysis: Identify connections between notes
- 👾 WebAssembly Support: Add
obsidian-parserto your Obsidian plugins
§Usage
Add to Cargo.toml:
[dependencies]
obsidian-parser = { version = "0.9", features = ["petgraph", "rayon", "digest"] }§Examples
§Basic Parsing
use obsidian_parser::prelude::*;
use serde::Deserialize;
// Parse single file with `HashMap`
let note_hashmap = NoteInMemory::from_file_default("note.md").unwrap();
assert!(!note_hashmap.is_todo().unwrap());
println!("Content: {}", note_hashmap.content().unwrap());
println!("Properties: {:#?}", note_hashmap.properties().unwrap().unwrap());
// Parse single file with custom struct
#[derive(Clone, Deserialize)]
struct NoteProperties {
created: String,
tags: Vec<String>,
priority: u8,
}
let note_with_serde: NoteInMemory<NoteProperties> = NoteInMemory::from_file("note.md").unwrap();§Vault Analysis
use obsidian_parser::prelude::*;
// Load entire vault
let options = VaultOptions::new("/path/to/vault");
let vault: VaultInMemory = VaultBuilder::new(&options)
.into_iter()
.filter_map(Result::ok)
.build_vault(&options);
// Check for duplicate note names
if !vault.have_duplicates_notes_by_name() {
eprintln!("Duplicate note names detected!");
}
// Access parsed notes
for note in vault.notes() {
println!("Note: {:?}", note);
}§Graph Analysis (requires petgraph feature)
#[cfg(feature = "petgraph")]
{
use obsidian_parser::prelude::*;
use petgraph::dot::{Dot, Config};
let options = VaultOptions::new("/path/to/vault");
let vault: VaultInMemory = VaultBuilder::new(&options)
.into_iter()
.filter_map(Result::ok)
.build_vault(&options);
let graph = vault.get_digraph().unwrap();
// Export to Graphviz format
println!("{:?}", Dot::with_config(&graph, &[Config::EdgeNoLabel]));
// Find most connected note
let most_connected = graph.node_indices()
.max_by_key(|n| graph.edges(*n).count())
.unwrap();
println!("Knowledge hub: {:?}", graph[most_connected]);
}§Performance
Optimized for large vaults:
- 🚀 1000 files parsed in 2.6 ms (avg)
- 💾 Peak memory: 900KB per 1000 notes
Parallel processing via Rayon (enable rayon feature)