No description
Find a file
2025-05-06 09:44:49 +01:00
.vs new logo 2025-04-22 16:55:25 +01:00
assets [UPDATE] Readme 2025-04-23 09:05:13 +01:00
icons new logo 2025-04-22 16:55:25 +01:00
methods replace crypto 2025-05-06 09:44:49 +01:00
settings Fix posting to root 2025-05-06 09:09:14 +01:00
types [UPDATE] Readme 2025-04-23 09:05:13 +01:00
.editorconfig Initial Commit 2025-04-22 13:48:24 +01:00
.eslintignore Initial Commit 2025-04-22 13:48:24 +01:00
.eslintrc Initial Commit 2025-04-22 13:48:24 +01:00
.gitignore Initial Commit 2025-04-22 13:48:24 +01:00
.hotreload Initial Commit 2025-04-22 13:48:24 +01:00
.npmrc Initial Commit 2025-04-22 13:48:24 +01:00
esbuild.config.mjs Initial Commit 2025-04-22 13:48:24 +01:00
global.d.ts Initial Commit 2025-04-22 13:48:24 +01:00
LICENSE Initial Commit 2025-04-22 13:48:24 +01:00
main.ts remove console.log 2025-05-06 09:11:50 +01:00
manifest.json Initial Commit 2025-04-22 13:48:24 +01:00
package-lock.json Initial Commit 2025-04-22 13:48:24 +01:00
package.json Initial Commit 2025-04-22 13:48:24 +01:00
README.md Update Readme 2025-05-06 09:19:19 +01:00
styles.css Initial Commit 2025-04-22 13:48:24 +01:00
tsconfig.json Initial Commit 2025-04-22 13:48:24 +01:00
version-bump.mjs Initial Commit 2025-04-22 13:48:24 +01:00
versions.json Initial Commit 2025-04-22 13:48:24 +01:00

Document Type

Umbracidian - a plugin for Obsidian

This plugin allows you to push your Obsidian notes to Umbraco 15+ as a blog post.

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.
Document Type

Setup API user

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

Demo of how to create an 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.

Setup Umbracian

Settings screen within Umbracidian

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. Blog Parent Node UUID - this is the parent node in Umbraco where your blog posts will be created under. You can find this by going to the content tree and clicking on the node. Leave blank if posting to root node.
  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 palete. The command you need for the command palete is Umbracidian: 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.