Skip to content

Commit

Permalink
Merge pull request #179 from omnivore-app/docs/folder-name
Browse files Browse the repository at this point in the history
docs: update obsidian filename and folder section to include new variables
  • Loading branch information
sywhb authored Feb 20, 2024
2 parents 07302f5 + 40d7959 commit 4d9a219
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions docs/integrations/obsidian.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Simplified template with full content and file attachment, if it there is one.
{{/fileAttachment}}
```

### Function map in the article template
### Function map in the article template {#function-map-in-the-article-template}

::: v-pre

Expand Down Expand Up @@ -261,23 +261,48 @@ date_published: {{{datePublished}}}
{{/datePublished}}
```

## Sync all the articles into a single note
## Customizing where the data is saved in Obsidian

By default, Omnivore will sync articles into separate pages in Obsidian. If you would like to sync all your articles into a single note, you can turn on the option **Is Single File** and use a fixed **Filename** in the plugin settings.
You can customize where the data is saved in Obsidian by defining the **Folder** and **Filename** templates in the plugin settings.

## Filename
### Folder

::: v-pre
Enter a filename for the article. You can either use a fixed filename or a template. If you use a template, the filename will be generated based on the template. For example, if you enter `{{{ title }}}`, the filename will be the title of the article.
Enter a folder name for the note. You can either use a fixed folder name or a template. If you use a template, the folder name will be generated based on the template. For example, if you enter `{{{ siteName }}}`, the folder name will be the name of the site the item was saved from so that the notes are organized by site.
:::

Available variables for the template are:
### Filename

::: v-pre
Enter a filename for the note. You can either use a fixed filename or a template. If you use a template, the filename will be generated based on the template. For example, if you enter `{{{ title }}}`, the filename will be the title of the item.
:::

### Available variables and functions for Folder and Filename templates

The meaning and usage of each variable and function is the same as the [variables and functions in the article template](#variables-available-in-the-template) and [function map in the article template](#function-map-in-the-article-template).

#### Variables

* id
* title
* author
* siteName
* type
* dateSaved
* datePublished
* dateArchived
* dateRead

#### Functions

* lowerCase
* upperCase
* upperCaseFirst
* formatDate

### Sync all the items into a single note

By default, Omnivore will sync items into separate notes in Obsidian. If you would like to sync all your items into a single note, you can turn on the option **Is Single File** and use a fixed **Filename** in the plugin settings.

## Scheduled Sync

Expand Down

0 comments on commit 4d9a219

Please sign in to comment.