Skip to content

02. Setup and Usage

Jump to bottom
Owain Williams edited this page Sep 16, 2025 · 5 revisions

Usage

Setup Umbraco Document Type

Within Umbraco, you need to create a new document type for your blog posts. This document type should have the following properties as a minimum:

  • Title (string)
  • BlogContent (MarkdownEditor) Make a note of the alias of the document type and also the alias of the properties. e.g. obsidian, title, blogContent.

Setup API user

Within Umbraco, you will need to create a new API user.

  • Go to Users > Create API user
  • Give the user a name and email address
  • Give the user a User Group - Once saved, go to the user and create Client Credentials. These are what are used when Obsidian connects to Umbraco. - You shouldnt use this account to log in to the backoffice, this is for API use only.

Install umbPublisher

setupumbPublisher

Setup umbPublisher

image

Note

Remeber to give your blog document type permission to either post on the root node or the parent node you are using.

  1. Website Url - this is the base URL of your umbraco site e.g https://owain.codes
  2. Client ID - this is setup within Umbraco when you create the API user
  3. Client Secret - this is setup within Umbraco when you create the API user
  4. Pick Content Parent Node - this is the parent node in Umbraco where your blog posts will be created under. Click Fetch Nodes and you will see your content tree from Umbraco. Select the parent node. Blog parent node UUID is for reference only and is auto populated from this picker
  5. DocType Alias - this is the alias of the document type you created in Umbraco for your blog posts. e.g. obsidian
  6. Title Alias - this is the alias of the title property you created in Umbraco for your blog posts. e.g. title
  7. Blog Content Editor Alias - this is the alias of the blog content property you created in Umbraco for your blog posts. e.g. blogContent

Pushing to Umbraco

Once everything is setup, you should now be able to push your content to Umbraco. It's important to make sure that you have clicked on the page you want to push. It's not enough to just open the note on to the screen. Place your cursor on the note, otherwise you will get a message saying No active Markdown view found

You can either click on the plugin icon on the left hand side menu or you can use the command palate. The command you need for the command palate is umbPublisher: Push to Umbraco command or just start typing Umbrac and the command will appear in the palette. Remember - you need to have the cursor on the note.

Clone this wiki locally