{"id":13593990,"url":"https://github.com/Nodsoft/MoltenObsidian","last_synced_at":"2025-04-09T05:32:44.891Z","repository":{"id":64161638,"uuid":"567057850","full_name":"Nodsoft/MoltenObsidian","owner":"Nodsoft","description":"Obsidian-flavoured Markdown parsing library for .NET 8+, with support for Obsidian Vaults navigation.","archived":false,"fork":false,"pushed_at":"2025-03-06T14:49:40.000Z","size":3154,"stargazers_count":68,"open_issues_count":7,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-06T15:36:49.332Z","etag":null,"topics":["aspnetcore","blazor","dotnet","extensions","html","library","markdig","markdown","moltenobsidian","obsidian","obsidian-md","obsidian-vault","ssg"],"latest_commit_sha":null,"homepage":"https://moltenobsidian.dev","language":"C#","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/Nodsoft.png","metadata":{"files":{"readme":"README.md","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":"2022-11-17T01:18:39.000Z","updated_at":"2025-03-02T22:19:19.000Z","dependencies_parsed_at":"2024-01-13T16:23:55.088Z","dependency_job_id":"6a9af65e-3f16-4d3b-8ab3-b81b8de4487a","html_url":"https://github.com/Nodsoft/MoltenObsidian","commit_stats":{"total_commits":62,"total_committers":2,"mean_commits":31.0,"dds":"0.016129032258064502","last_synced_commit":"26b52d60246f870179f7952491add41545334894"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nodsoft%2FMoltenObsidian","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nodsoft%2FMoltenObsidian/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nodsoft%2FMoltenObsidian/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nodsoft%2FMoltenObsidian/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nodsoft","download_url":"https://codeload.github.com/Nodsoft/MoltenObsidian/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987056,"owners_count":21028891,"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":["aspnetcore","blazor","dotnet","extensions","html","library","markdig","markdown","moltenobsidian","obsidian","obsidian-md","obsidian-vault","ssg"],"created_at":"2024-08-01T16:01:27.291Z","updated_at":"2025-04-09T05:32:39.878Z","avatar_url":"https://github.com/Nodsoft.png","language":"C#","funding_links":[],"categories":["C# #","C\\#","C#"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"icon.png\" alt=\"logo\" width=\"256\"/\u003e\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eMoltenObsidian\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003e.NET 6+ Library for \u003ca href=\"https://obsidian.md\"\u003eObsidian\u003c/a\u003e-flavoured Markdown parsing, with support for vault mapping and Blazor.\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n\t\u003chr /\u003e\n\t\u003cimg alt=\"GitHub Actions Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/Nodsoft/MoltenObsidian/build.yml?style=flat\u0026logo=github\u0026label=test%2Fbuild\"\u003e\n\t\u003cimg alt=\"NuGet Core Version\" src=\"https://img.shields.io/nuget/v/Nodsoft.MoltenObsidian?style=flat\u0026logo=nuget\u0026label=core\"\u003e\n\t\u003cimg alt=\"NuGet Core Preversion\" src=\"https://img.shields.io/nuget/vpre/Nodsoft.MoltenObsidian?style=flat\u0026logo=nuget\u0026label=core%20(pre)\"\u003e\n\t\u003cimg alt=\"NuGet Downloads\" src=\"https://img.shields.io/nuget/dt/Nodsoft.MoltenObsidian?style=flat\u0026logo=nuget\"\u003e\n \t\u003chr /\u003e\n \u003c/div\u003e\n \u003cdiv\u003e\u0026#8203;\u003c/div\u003e\n\n## Premise\n\nMolten Obsidian is a high-performance library designed as an easily integrated and lightweight FOSS alternative to [Obsidian Publish](https://publish.obsidian.md). \nWith extensibility and integration-oriented conception, this library makes it perfect for integrating Obsidian-flavoured markdown notes on your Blazor App, but also importing entire vaults as a navigation-ready area, with full routing support.\n\nFurthermore, Molten Obisidian extends past the original [Obsidian specifications](https://help.obsidian.md/), aiming to supercharge your documentation/wiki applications and websites needs, using a customizable data source interface, and supercharged YAML frontmatter capabilities.\n\n### Example\n\n**Converting an Obsidian-flavoured Markdown note to HTML** is as simple as this : \n```csharp\nusing Nodsoft.MoltenObsidian;\n\n// Create a new ObsidianText instance with the content to convert\nObsidianText obsidianMarkdown = new(@\"\n# Hello, world!   \n\nThis is a sample Markdown document.    \nAnd a paragraph with **bold** and *italic* text.\n\");\n\n// This is the HTML string you can then call in Blazor components as `@htmlText`.\nMarkupString htmlText = obsidianMarkdown.ToHtml();\n```\nBut that's just the basics. Under the hood, [Markdig](https://github.com/xoofx/markdig) is what makes it happen. Easy!\n\n\n**Now let's open an Obsidian vault on the Filesystem, and wire it to a routable Blazor component :**  \n\n*`Startup.cs`*\n```csharp\nusing Nodsoft.MoltenObsidian.Blazor;\nusing Nodsoft.MoltenObsidian.Vault;\nusing Nodsoft.MoltenObsidian.Vaults.FileSystem;\n\n// First deal with the DI, by adding a Filesystem vault and the Blazor integration:\npublic void ConfigureServices(IServiceCollection services)\n{\n\tservices.AddMoltenObsidianFileSystemVault(new DirectoryInfo(\"/path/to/vault\"));\n\tservices.AddMoltenObsidianBlazorIntegration();\n}\n```\n*`_Imports.razor`*\n```razor\n@using Nodsoft.MoltenObsidian.Blazor\n@using Nodsoft.MoltenObsidian.Blazor.Helpers;\n@using Nodsoft.MoltenObsidian.Vault;\n```\n*`VaultPage.razor`*\n```razor\n@page \"/vault/{*VaultPath}\"  \n@inject IVault Vault   \n  \n\u003cObsidianVaultDisplay BasePath=\"@this.GetCallingBaseVaultPath()\" CurrentPath=\"@VaultPath\" /\u003e  \n  \n@code {  \n   [Parameter]  \n   public string VaultPath { get; set; }\n}\n```\n\nIn a matter of minutes, you've just created a web app integration for your own Obsidian Vault, for all to see. Congratulations!\n\nNow, let's take it further.\n\n## Customizations\n\n### Vault sources (see: [Vaults](/Vaults))\nMolten Obsidian is designed with extensibility at its core, and allows you to implement your own Vault source. Should the [**existing reference Vault providers**](/Vaults) not be suitable for your Vault storage needs, you can provide your own implementation. \n\n**A few examples of additional stores you can implement:**\n - Database store (xSQL, MongoDB, etc...)\n - Over-the-wire/Network-based (NFS, etc...)\n - VCS-based (Git repo)\n\nIf you're finding yourself implementing any of these, feel free to PR! We'll be more than happy to support new vault providers.\n\n### Layouts\nMolten Obsidian is meant to tailor itself to your app. As such, you can provide within the Blazor Component a series of `RenderFragment` delegates responsible for organizing the Vault display.\n\nYou can provide them in cascade, as such :\n```razor\n\u003cObsidianVaultDisplay BasePath=\"@this.GetCallingBaseVaultPath()\" CurrentPath=\"@VaultPath\"\u003e  \n   \u003cFoundFile Context=\"file\"\u003e  \n      \u003ch1\u003eVault note: @file.NoteName\u003c/h1\u003e  \n      \u003ca class=\"lead text-muted\" href=\"@file.Parent?.Path\"\u003eReturn to @(file.Parent?.Name ?? \"Root\")\u003c/a\u003e  \n  \n      \u003chr /\u003e  \n  \n      @(new MarkupString(file.ReadDocument().ToHtml()))  \n   \u003c/FoundFile\u003e  \n  \n   \u003cNotFound\u003e  \n      \u003ch3 class=\"text-warning\"\u003eSorry, there is nothing here.\u003c/h3\u003e  \n   \u003c/NotFound\u003e  \n\u003c/ObsidianVaultDisplay\u003e\n```\n\nAlternatively, you can provide delegates, like so :\n```razor\n\u003cObsidianVaultDisplay BasePath=\"@this.GetCallingBaseVaultPath()\" CurrentPath=\"@VaultPath\"  \n   FoundFile=\"OnFoundFile\"  \n   NotFound=\"OnNotFound\"  \n/\u003e  \n\n@code {  \n   public static RenderFragment OnFoundFile(IVaultNote file) =\u003e __builder =\u003e  \n   {  \n      \u003ch1\u003eVault note: @file.NoteName\u003c/h1\u003e  \n      \u003ca class=\"lead text-muted\" href=\"@file.Parent?.Path\"\u003eReturn to @(file.Parent?.Name ?? \"Root\")\u003c/a\u003e  \n\n      \u003chr /\u003e  \n\n      @(new MarkupString(file.ReadDocument().ToHtml()))  \n   };  \n     \n   public static RenderFragment OnNotFound(string _) =\u003e static __builder =\u003e  \n   {  \n      \u003ch3 class=\"text-warning\"\u003eSorry, there's nothing here.\u003c/h3\u003e  \n   }; \n}\n```\n\n\n## CLI Tool\nOur CLI tool aims at cutting down the menial tasks associated with implementing more advanced features of Molten Obsidian, allowing you to better focus on what matters, but also automating any of those integration tasks within you workflow.\n\n### ***See: [Nodsoft.MoltenObsidian.Tool](/Nodsoft.MoltenObsidian.Tool)***\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNodsoft%2FMoltenObsidian","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNodsoft%2FMoltenObsidian","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNodsoft%2FMoltenObsidian/lists"}