https://github.com/jahredhope/obsidian-fore-plugin

Frontmatter automation for Obsidian
https://github.com/jahredhope/obsidian-fore-plugin

Last synced: 16 days ago
JSON representation

Frontmatter automation for Obsidian

• Host: GitHub
• URL: https://github.com/jahredhope/obsidian-fore-plugin
• Owner: jahredhope
• Created: 2023-05-19T22:23:41.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-06-03T07:35:31.000Z (over 1 year ago)
• Last Synced: 2024-10-19T02:00:25.791Z (29 days ago)
• Language: TypeScript
• Homepage:
• Size: 218 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Fore - Frontmatter Automation, an Obsidian Plugin

**Note:** This project is only intended for personal use and is not feature complete.

-   Add and Remove Tags for entire folders of files

-   Add Aliases and Tags with commands and hotkeys

-   Automate Aliases from file name conventions

-   Automate Tags from folder structure

This is a plugin for Obsidian (https://obsidian.md).



**Why "Fore"?** Fore, meaning "Located at or toward the front" is in reference to updating frontmatter. But it's also a nice short name to put in the context menu.



## How to Install

Currently this plugin is not published to Obsidian.

To trial it now install and use [BRAT], following the steps listed entering the below URL when prompted:

```

https://github.com/jahredhope/obsidian-fore-plugin

```

### Set Alias from Name

Automatically add a shorter alias to files based on your own common file name convention.

Describe your file naming convention using [parameterized path] or regular expression. The command will then look for the parameter "name" and add it to your alias.

[parameterized path]: https://www.npmjs.com/package/path-to-regexp

#### Example:

```

{:date(\\d\\d\\d\\d-\\d\\d-\\d\\d) - }?{:kind - }?{:name}{, :descriptor}?

```

**with Date and Kind**

```

"2020-03-39 - Meeting - Product Roadmap" => Alias: Product Roadmap

```

**with Kind and Descriptor**

```

E.g. "Tool - Skaffold, Kubernetes Deployment" => Alias: Skaffold"

```

### Set Tag from File Path

Automatically add tags in a document's frontmatter that matches the files path.

E.g. Tool/Skaffold.md => `#tool`

E.g. Person/Jimmy/Articles => `#Person/Jimmy`

## Development Workflow

Clone the project into a new folder in `/path/to/vault/.obsidian/plugins/`.

#### Install Dependencies

```

pnpm install

pnpm dev

```

#### Install [Hot Reload] via [BRAT]

In Obsidian install and enable the community plugin [Obsidian42 - BRAT][brat].

Once enabled use it to add the following Plugin URL: `https://github.com/pjeby/hot-reload`

[hot reload]: https://github.com/pjeby/hot-reload

[brat]: https://github.com/TfTHacker/obsidian42-brat