diff --git a/nodsoft_moltenobsidian_web/vault/Getting Started.md b/nodsoft_moltenobsidian_web/vault/Getting Started.md index adc2145..29be95a 100644 --- a/nodsoft_moltenobsidian_web/vault/Getting Started.md +++ b/nodsoft_moltenobsidian_web/vault/Getting Started.md @@ -3,6 +3,32 @@ order: 5 --- # Getting Started +MoltenObsidian can be used with two different methods : +- **Library :** Use the .NET MoltenObsidian library to provide programmatic Obsidian integration within your .NET / ASP.NET Core application *(see below)*. +- **CLI Tool :** Use the CLI tool to integrate externally and/or at build time on any web application *(see [[Tool/Index|Tools]])*. + +As all tool-related operations are detailed on [[Tool/Index|the tool's readme]], this page focuses on getting started using the .NET library. + +## Installing the library +The MoltenObsidian library can be found on [NuGet](https://www.nuget.org/packages?q=Tags:"moltenobsidian"). Here's a rundown of the main packages you'll be using : +- [`Nodsoft.MoltenObsidian`](https://www.nuget.org/packages/Nodsoft.MoltenObsidian): The backbone of the library. Include this package if none other, as it is implicitly referenced by all other packages. +- [`Nodsoft.MoltenObsidian.Blazor`](https://www.nuget.org/packages/Nodsoft.MoltenObsidian.Blazor): The Blazor integration. This package provides a turnkey solution for Blazor Server, United, and WASM based applications. +- [[Vaults/Index|A vault provider]]: One of them will be required to import a vault. + +Package installation follows the same pattern as other NuGet packages. +Use your IDE's package manager, or run these commands within the root of your .NET project : +```sh +# Base packages +dotnet package add "Nodsoft.MoltenObsidian" # For basic Obsidian Markdown conversions +dotnet package add "Nodsoft.MoltenObsidian.Blazor" # For Blazor Integration + +# Vault providers +dotnet package add "Nodsoft.MoltenObsidian.Vaults.FileSystem" # For local vaults, imported from the filesystem +dotnet package add "Nodsoft.MoltenObsidian.Vaults.Http" # For remote vaults pulled over HTTP +dotnet package add "Nodsoft.MoltenObsidian.Vaults.Ftp" # For remote vaults located on FTP shares +``` +Not all packages are necessary depending on your needs. + ## Converting raw Markdown **Converting an Obsidian-flavoured Markdown note to HTML** is as simple as this :