Obsidian::Parser

A (work in progress) gem to parse notes created with the Obsidian note-taking tool.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add obsidian-parser

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install obsidian-parser

Usage

WARNING: This API is not yet finalized.

parser = Obsidian::Parser.new(Pathname.new("/path/to/vault"))

puts parser.index.notes
# -> [ Note(title: "README", slug: "README") ]

puts parser.index.directories
# -> [ Index(title: "Drafts", slug: "Drafts"),
#      Index(title: "Projects", slug: "Projects") ]

Generating HTML

title = note.title
content = note.content
content.generate_html

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/matmoore/obsidian-parser.

Resources and similar projects

• Obsidian link formats
• Obisidian metadata format
• Obsidian flavored markdown
• Is there a parser/renderer reference spec? (No)
• Obsidian-Markdown-Parser (Python)

License

The gem is available as open source under the terms of the MIT License.