Obsidian Help

https://obsidian.md/help/
Admin
Obsidian Help is the official documentation and guide for Obsidian, a powerful note-taking and...
Tokens:55,592
Snippets:619
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Configure a complete Obsidian base file

Source: https://obsidian.md/help/bases/syntax

Full YAML schema example of a .base file defining global filters, formulas, property display names, custom summaries, and table view configurations.

```yaml
filters:
  or:
    - file.hasTag("tag")
    - and:
        - file.hasTag("book")
        - file.hasLink("Textbook")
    - not:
        - file.hasTag("book")
        - file.inFolder("Required Reading")
formulas:
  formatted_price: 'if(price, price.toFixed(2) + " dollars")'
  ppu: "(price / age).toFixed(2)"
properties:
  status:
    displayName: Status
  formula.formatted_price:
    displayName: "Price"
  file.ext:
    displayName: Extension
summaries:
  customAverage: 'values.mean().round(3)'
views:
  - type: table
    name: "My table"
    limit: 10
    groupBy:
      property: note.age
      direction: DESC
    filters:
      and:
        - 'status != "done"'
        - or:
            - "formula.ppu > 5"
            - "price > 2.1"
    order:
      - file.name
      - file.ext
      - note.age
      - formula.ppu
      - formula.formatted_price
    summaries:
      formula.ppu: Average

```

--------------------------------

### Define frontmatter aliases and permalink

Source: https://obsidian.md/help/advanced-syntax

Sets note metadata at the start of a note to define aliases and a permalink.

```yaml
aliases:
  - Advanced Markdown
permalink: advanced-syntax
```

--------------------------------

### Configure Sway to focus Obsidian on window activation

Source: https://obsidian.md/help/web-clipper/troubleshoot

Add this window rule to ~/.config/sway/config to ensure Obsidian gains focus and clipboard read access on activation.

```plaintext
# ~/.config/sway/config
for_window [class="obsidian"] focus_on_window_activation focus
```

--------------------------------

### Configure Hyprland to focus on activate for clipboard access

Source: https://obsidian.md/help/web-clipper/troubleshoot

Add this setting to ~/.config/hypr/hyprland.conf to allow Obsidian to receive clipboard permissions when activated under Wayland.

```plaintext
# ~/.config/hypr/hyprland.conf
misc {
    focus_on_activate = true
}
```

--------------------------------

### Set page frontmatter and aliases

Source: https://obsidian.md/help/web-clipper/highlight

Defines the permalink and search aliases for the Highlighter documentation note.

```yaml
permalink: web-clipper/highlight
aliases:
  - highlights
  - Highlighter
```

--------------------------------

### Create a Markdown table with headers

Source: https://obsidian.md/help/advanced-syntax

Constructs a table using vertical bars (|) to separate columns and hyphens (-) to define headers. Outer vertical bars are optional but recommended for readability.

```markdown
| First name | Last name |
| ---------- | --------- |
| Max        | Planck    |
| Marie      | Curie     |
```

--------------------------------

### Filter base datasets with simple and complex conditions

Source: https://obsidian.md/help/bases/syntax

Demonstrates narrowing base files using basic 'and' conditions as well as nested logical 'or', 'and', and 'not' filter blocks.

```yaml
# Simple filter:
filters:
  and:
    - file.hasTag("tag")

# Complex filter:
filters:
  or:
    - file.hasTag("tag")
    - and:
        - file.hasTag("book")
        - file.hasLink("Textbook")
    - not:
        - file.hasTag("book")
        - file.inFolder("Required Reading")

```

--------------------------------

### obsidian://new

Source: https://obsidian.md/help/uri

The `new` action creates a new note in the specified vault, optionally populated with content or clipboard data, and controls opening behavior.

```APIDOC
## obsidian://new

### Description
Creates a new note in the vault, optionally with some content.

### Endpoint / URI
`obsidian://new`

### Parameters
#### Query Parameters
- **vault** (string) - Optional - Vault name or vault ID.
- **name** (string) - Optional - File name to be created. Location is chosen based on default preferences.
- **file** (string) - Optional - Vault absolute path, including the name. Overrides `name` if specified.
- **path** (string) - Optional - Globally absolute path. Overrides both `vault` and `file`.
- **paneType** (string) - Optional - Determines where the note will be opened in the UI.
- **content** (string) - Optional - The contents of the note.
- **clipboard** (boolean) - Optional - Use the contents of the clipboard instead of specifying `content`.
- **silent** (boolean) - Optional - Include this parameter if you don't want to open the new note.
- **append** (boolean) - Optional - Include this parameter to append to an existing file if one exists.
- **overwrite** (boolean) - Optional - Overwrite an existing file if one exists, but only if `append` is not set.
- **x-success** (string) - Optional - Callback parameter for x-callback-url handling.

### Examples
- `obsidian://new?vault=my%20vault&name=my%20note`
- `obsidian://new?vault=my%20vault&file=path%2Fto%2Fmy%20note`
```

--------------------------------

### obsidian://choose-vault

Source: https://obsidian.md/help/uri

Opens the Obsidian vault manager.

```APIDOC
## URI obsidian://choose-vault

### Description
The `choose-vault` action opens the vault manager.

### Endpoint
`obsidian://choose-vault`

### Examples
- `obsidian://choose-vault`
```

--------------------------------

### Insert a basic editable table structure

Source: https://obsidian.md/help/advanced-syntax

Generates a basic blank table template when using the Insert Table command or selecting Insert → Table from the context menu.

```markdown
|     |     |
| --- | --- |
|     |     |
```
Tokens:
Raw