umbPublisher

umbPublisher - an Obsidian plugin.

This plugin allows you to push your Obsidian notes to Umbraco 15+ as a content item.

It uses the Management API within Umbraco to create notes in Markdown format. You will need to create an API user in Umbraco for this to work.

To see how to use this plugin with Obsidian, check out the Wiki pages

Settings

Open Settings > umbPublisher in Obsidian to configure the plugin.

API Credentials

Content Structure

1. Pick content parent node - Click "Fetch nodes" to load your Umbraco content tree. Select the parent node where new documents will be created as children.

2. Allowed child document types - After selecting a parent node, click "Fetch child doc types" to load the document types allowed under that parent. Select the document type to use when creating new documents.

Content Mode

Choose how your markdown content is stored on the Umbraco document type. The three modes are mutually exclusive - select the one that matches your Umbraco setup.

Property Editor (default)

Content is written directly to properties on the document type. This is the simplest mode.

Settings:

• Title property - The property alias for the document title (e.g. title)
• Content property - The property alias for the markdown content (e.g. blogContent)

Click "Fetch properties" to load the available properties from your document type, then select the appropriate ones from the dropdowns.

Block List

Content is wrapped in an Umbraco Block List structure. Use this when your document type stores content inside a Block List property.

Settings:

• Block List property - Select the Block List property on your document type
• Block List element type - Select the element type used for content blocks within the Block List
• Content property - Select the property on the element type where the markdown content will be stored

Each setting has a "Fetch" button to load the available options from your Umbraco instance. Configure them in order from top to bottom, as each depends on the previous selection.

Block Grid

Content is wrapped in an Umbraco Block Grid structure. Use this when your document type stores content inside a Block Grid property.

Settings:

• Block Grid property - Select the Block Grid property on your document type
• Block Grid element type - Select the element type used for content blocks within the Block Grid
• Content property - Select the property on the element type where the markdown content will be stored

Configuration works the same as Block List mode. Column span and row span are determined by your Block Grid configuration in Umbraco.

Optional Properties

These are available in every content mode and are set on the document itself (not inside a block). Leave them as [None] to skip them.

• Tags property - An Umbraco Tags property that receives the note's frontmatter tags

• Description property - A property that receives the note's frontmatter description. Pick whichever editor suits your site:

  • Text area / text box - the description is sent as-is
  • Markdown editor - the description is sent as-is
  • Rich text editor - the description is HTML-escaped and wrapped in a paragraph

  The description is always treated as plain text. Markdown in it is not converted. Notes without a description leave the property empty.

---
title: My post
description: A short summary of the post.
tags:
  - Umbraco
---

Publishing

Once configured, you can publish the currently active markdown note to Umbraco in two ways:

1. Ribbon icon - Click the umbPublisher icon in the left sidebar
2. Command palette - Open the command palette (Ctrl/Cmd + P) and run "Push to Umbraco"

The plugin will:

• Parse the markdown content from your active note
• Upload any embedded local images to the Umbraco media library, into an "Obsidian" folder
  • Both Obsidian embeds (![[image.png]], including |400 sizing and #subpath suffixes) and standard markdown images (![alt](https://raw.githubusercontent.com/owainwilliams/umbpublisher/HEAD/images/image.png)) are supported
  • Each embed is replaced with an <img> tag pointing at the uploaded media, and images already in the media library are reused rather than re-uploaded
  • Images already hosted elsewhere (http(s)://, data:) are left untouched, and anything that fails to upload is reported in a notice
• Send the note's frontmatter tags and description to their mapped properties, if configured
• Create a new document in Umbraco under your configured parent node

Upgrading from v1.3.x

If you previously used the "Use Block List" toggle, your settings will be automatically migrated to the new content mode system on first load. No action is required - useBlockList: true becomes "Block List" mode, and useBlockList: false becomes "Property Editor" mode.

Contributions

All contributions are welcome. This project is written in Typescript and is Open Source. If you have features you'd like added, feel free to create a new issue.