{"id":15713632,"url":"https://github.com/roy-corentin/org_mob_parser","last_synced_at":"2025-03-30T18:47:38.003Z","repository":{"id":153077081,"uuid":"611842948","full_name":"roy-corentin/org_mob_parser","owner":"roy-corentin","description":"Parser for Org files","archived":false,"fork":false,"pushed_at":"2024-03-26T21:37:03.000Z","size":75,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T20:58:20.830Z","etag":null,"topics":["crystal-lang","org-mode","parser"],"latest_commit_sha":null,"homepage":"","language":"Crystal","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/roy-corentin.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-03-09T16:52:24.000Z","updated_at":"2024-03-26T21:36:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"384345d1-72ba-41e6-bbd3-26425e4c7f8b","html_url":"https://github.com/roy-corentin/org_mob_parser","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roy-corentin%2Forg_mob_parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roy-corentin%2Forg_mob_parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roy-corentin%2Forg_mob_parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roy-corentin%2Forg_mob_parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roy-corentin","download_url":"https://codeload.github.com/roy-corentin/org_mob_parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246365640,"owners_count":20765546,"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":["crystal-lang","org-mode","parser"],"created_at":"2024-10-03T21:32:33.636Z","updated_at":"2025-03-30T18:47:37.684Z","avatar_url":"https://github.com/roy-corentin.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"* ORG MOB PARSER\n\nOrgMobParser is a high-performance parser for [[https://orgmode.org/][Org]] files, powered by the [[https://crystal-lang.org/][Crystal]] programming language.\n\n** Introduction\nOrgMobParser was developed with the primary purpose of serving as the parsing engine for a backend application known as =OrgMob= (Work in Progress).\nHowever, it is a versatile tool, and you are free to use it in any way that suits your needs!\n\n** Features\n+ =Blazingly Fast=: Thanks to Crystal's efficiency, OrgMobParser offers exceptional parsing speed for Org files.\n+ =Easy Integration=: Seamlessly integrate OrgMobParser into your Crystal projects or any compatible application.\n+ =Inspired by UniOrg=: The format used by OrgMobParser closely resembles that of [[https://github.com/rasendubi/uniorg][UniOrg]]. However, please note that full compatibility with UniOrg is not a current priority.\n\n** Installation\n1. Add the dependency to your =shard.yml=\n\n#+begin_src yaml\ndependencies:\n  org_mob_parser:\n    github: roy-corentin/org_mob_parser\n#+end_src\n\n2. Run =shards install=\n\n** Usage\n\n#+begin_src crystal\nrequire \"org_mob_parser\"\n#+end_src\n\n*** For Custom TODO Keywords\n#+begin_src crystal\nparser = OrgMob::Parser.new\n\nparser.configure do |c|\n  c.todo_keywords = [\"TODO\", \"[ ]\", \"TODO 🚩\", \"DOING\"]\nend\n#+end_src\n\n*** For Custom DONE Keywords\n#+begin_src crystal\nparser = OrgMob::Parser.new\n\nparser.configure do |c|\n  c.done_keywords = [\"DONE\", \"[X]\", \"DONE ❌\"]\nend\n#+end_src\n\n*** To Parse Your Text\n#+begin_src crystal\nparser = OrgMob::Parser.new\nparser.parse(\"* Your Org\\nyes your org note\") # Return a json in the OrgMob Format\nparser.parse(\"./path_to_org_file\") # Return a json in the OrgMob Format\n#+end_src\n\n** Development\n\n*** Parser System\n+ [X] parse emphasis\n+ [X] parse top file properties\n+ [X] parse block code\n+ [X] parse block quote\n+ [X] parse title properties\n+ [X] parser table\n\n*** Parser Lib\n+ [X] accept file to parse\n\n*** Parser Binary\n+ [X] binary to parse string or file\n\n*** Project\n+ [ ] Add benchmark\n\n** Contributing\n\n1. Fork it (\u003chttps://github.com/roy-corentin/org_mob_parser/fork\u003e)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n** Contributors\n\n- [[https://github.com/roy-corentin][Corentin Roy]] - creator and maintainer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froy-corentin%2Forg_mob_parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froy-corentin%2Forg_mob_parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froy-corentin%2Forg_mob_parser/lists"}