{"id":17868214,"url":"https://github.com/matmoore/obsidian-parser","last_synced_at":"2025-06-16T04:08:20.830Z","repository":{"id":181226668,"uuid":"665727779","full_name":"MatMoore/obsidian-parser","owner":"MatMoore","description":"Parse notes created with the Obsidian note-taking tool","archived":false,"fork":false,"pushed_at":"2024-07-18T07:52:21.000Z","size":186,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T00:46:05.254Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MatMoore.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-12T21:33:45.000Z","updated_at":"2025-03-09T11:32:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"488deb2c-cec9-4192-844e-65734ef400b0","html_url":"https://github.com/MatMoore/obsidian-parser","commit_stats":null,"previous_names":["matmoore/obsidian-parser"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatMoore%2Fobsidian-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatMoore%2Fobsidian-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatMoore%2Fobsidian-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MatMoore%2Fobsidian-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MatMoore","download_url":"https://codeload.github.com/MatMoore/obsidian-parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244790727,"owners_count":20510796,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-28T09:57:18.218Z","updated_at":"2025-03-21T11:31:25.713Z","avatar_url":"https://github.com/MatMoore.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Obsidian::Parser\n\nA gem to parse notes created with the Obsidian note-taking tool.\n\n## Installation\n\nInstall the gem and add to the application's Gemfile by executing:\n\n    $ bundle add obsidian-parser\n\nIf bundler is not being used to manage dependencies, install the gem by executing:\n\n    $ gem install obsidian-parser\n\n## Usage\n\nParse the vault with:\n\n```ruby\nrequire 'obsidian/parser'\nparser = Obsidian::Parser.new(Pathname.new(\"/path/to/vault\"))\n```\n\nThe return object allows you to iterate over all pages in the vault.\n\nA page is any note or directory within the vault.\n\nIf a directory contains an `index.md`, that will be used as the directory content. Otherwise, the directory will have no content.\n\n```ruby\nputs parser.pages\n# -\u003e [ Page(title: \"\", slug: \"\"), Page(title: \"Foo\", slug: \"Foo\"), Page(title: \"Bar\", slug: \"Foo/Bar\") ]\n```\n\nYou can fetch pages by their slug (the relative path, without a leading slash):\n\n```ruby\npage = parser.index.find_in_tree(\"foo/bar\")\n```\n\nPage objects have titles, slugs, and a callable to fetch their content:\n\n```ruby\npage = parser.pages[-1]\ntitle = page.title\nmarkdown = page.content.call\nhtml = page.generate_html\n```\n\n## Development\n\nAfter 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.\n\nTo 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](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/matmoore/obsidian-parser.\n\n## Resources and similar projects\n\n- [Obsidian link formats](https://help.obsidian.md/Linking+notes+and+files/Internal+links)\n- [Obisidian metadata format](https://help.obsidian.md/Editing+and+formatting/Metadata)\n- [Obsidian flavored markdown](https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown)\n- [Is there a parser/renderer reference spec? (No)](https://forum.obsidian.md/t/is-there-a-parser-renderer-reference-spec/29504/4)\n- [Obsidian-Markdown-Parser](https://github.com/danymat/Obsidian-Markdown-Parser) (Python)\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatmoore%2Fobsidian-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatmoore%2Fobsidian-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatmoore%2Fobsidian-parser/lists"}