Skip to content
This repository has been archived by the owner on Jul 1, 2024. It is now read-only.

Commit

Permalink
docs: include move metadata in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
natelandau committed Mar 12, 2023
1 parent 8cefca2 commit 556acc0
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Once installed, run `obsidian-metadata` in your terminal to enter an interactive
- **List notes in scope**: List notes that will be processed.

**Add Metadata**: Add new metadata to your vault.

When adding a new key to inline metadata, the `insert location` value in the config file will specify where in the note it will be inserted.

- **Add new metadata to the frontmatter**
Expand All @@ -78,7 +79,14 @@ When adding a new key to inline metadata, the `insert location` value in the con
- **Delete a value from a key**
- **Delete an inline tag**

**Move Inline Metadata**: Move inline metadata to a specified location with a note

- **Move to Top**: Move all inline metadata beneath the frontmatter
- **Move to After Title**: Move all inline metadata beneath the first markdown header
- **Move to Bottom**: Move all inline metadata to the bottom of the note

**Transpose Metadata**: Move metadata from inline to frontmatter or the reverse.

When transposing to inline metadata, the `insert location` value in the config file will specify where in the note it will be inserted.

- **Transpose all metadata** - Moves all frontmatter to inline metadata, or the reverse
Expand Down
13 changes: 11 additions & 2 deletions src/obsidian_metadata/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,13 +135,22 @@ def main(
• Delete a value from a key
• Delete an inline tag
[bold underline]Move Inline Metadata[/]
Move inline metadata to a specified location with a note
• Move to Top - Move all inline metadata beneath the frontmatter
• Move to After Title* - Move all inline metadata beneath the first markdown header
• Move to Bottom - Move all inline metadata to the bottom of the note
[bold underline]Transpose Metadata[/]
Move metadata from inline to frontmatter or the reverse.
Move metadata from inline to frontmatter or the reverse. When transposing to inline metadata,
the `insert location` value in the config file will specify where in the
note it will be inserted.
• Transpose all metadata - Moves all frontmatter to inline
metadata, or the reverse
• Transpose key - Transposes a specific key and all it's values
• Transpose value- Transpose a specific key:value pair
• Transpose value - Transpose a specific key:value pair
[bold underline]Review Changes[/]
Prior to committing changes, review all changes that will be made.
Expand Down

0 comments on commit 556acc0

Please sign in to comment.