Omnivore

Share this post

Using the Omnivore Obsidian plugin's new metadata customization features

blog.omnivore.app

Discover more from Omnivore

Updates from the Omnivore team
Over 3,000 subscribers
Continue reading
Sign in

Using the Omnivore Obsidian plugin's new metadata customization features

Learn how to customize the front matter when importing your reading from Omnivore to Obsidian

Omnivore
Jun 1, 2023
16
Share this post

Using the Omnivore Obsidian plugin's new metadata customization features

blog.omnivore.app
Share

One of the important features of the Omnivore Obsidian plug-in is the ability to customize your imported data with templates. Using templates you can customize the layout of the imported article data and highlights. You can read more about customizing the data imported into Obsidian here.

With our latest release (1.4.0) we’ve added new ways of customizing your metadata with Front Matter Settings.

Our philosophy is to always give users as much control of their data as possible, but start with sensible defaults and tools for users that want things to just work.

But remember, with great flexibility…

Customizing imported Metadata

With the new front matter tools there are now three levels of customization you can choose from:

  1. List the values you’d like imported

  2. Use aliases in the front matter list

  3. Create a custom front matter template

List the front matter values you’d like imported

In the Omnivore plugin settings you can list the metadata items you’d like imported into Obsidian. The defaults will import items like title, author, and tags. If you’d like to add or remove some of the default items you can see the available list of items in our docs.

Some of these values will not always be available: for example tags are only available if you have set labels on the item in Omnivore. If not set, these values will not be added.

These values will be set in the front matter of your markdown files, so you will see them at the top of a page, like this:

note: Omnivore adds the id value for internal usage.

Use aliases in the front matter list

If you’d like to rename a value you can use aliasing in the front matter settings. For example, to change “date_saved” to “date saved” you could alias the value like this: “date_saved::date saved”

Create a custom front matter template

If you need to further customize your metadata you can go into the Omnivore Advanced Settings in Obsidian and create a custom template. (See example below).

Note: When creating a custom template, it is important to render valid YAML. It is very easy to create invalid YAML with templates and imported data. Omnivore will validate the rendered data, and if it is invalid data it will create front matter with an
”omnivore_error” element. For example, the template listed below will create an error if the title has a “ symbol in it.

This template:

Created the following metadata:

To avoid escaping errors in templates, its recommended to use YAML multiline strings, for example:

Feedback Appreciated

We made these metadata changes based on community feedback. If there is a way we can make the Omnivore Obsidian plugin work better for you and your desired workflow, please join our discord and let us know, or file a GitHub issue.

16
Share this post

Using the Omnivore Obsidian plugin's new metadata customization features

blog.omnivore.app
Share
Previous
Next
Top
New
Community

No posts

Ready for more?

© 2023 Omnivore
Privacy ∙ Terms ∙ Collection notice
Start WritingGet the app
Substack is the home for great writing