Icon Folder Yaml

Intended to be used with Iconize, Mkdocs Material (icons) and Obsidian Publisher.

The idea is to add keys into the frontmatter:

• icon : folderIcon/icon
• icon_file : [[iconFile]] (only if the svg is not in .obsidian or other hidden folder)

Obsidian Publisher will send the icon_file into your Repository, and Mkdocs Material will use the icon key to display the icon.

⚙️ Usage

The plugin add a command to the command palette: Iconize assistant : Add icon to frontmatter

📥 Installation

• From Obsidian's community plugins
• Using BRAT with https://github.com/Lisandra-dev/iconize-assistant
  → Past this into your browser : obsidian://brat?plugin=https://github.com/Lisandra-dev/iconize-assistant
• From the release page: - Download the latest release - Unzip icon-folder-yaml.zip in .obsidian/plugins/ path - In Obsidian settings, reload the plugin - Enable the plugin

🤖 Developing

To make changes to this plugin, first ensure you have the dependencies installed.

pnpm install

To start building the plugin with what mode enabled run the following command:

pnpm run dev

Note If you haven't already installed the hot-reload-plugin you'll be prompted to. You need to enable that plugin in your obsidian vault before hot-reloading will start. You might need to refresh your plugin list for it to show up. To start a release build run the following command:

pnpm run build

Note You can use the .env file with adding the key VAULT_DEV to specify the path to your Obsidian (development) vault. This will allow you to test your plugin without specify each times the path to the vault.

📤 Export

You can use the pnpm run export command to export your plugin to your Obsidian Main Vault. To do that, you need the .env file with the following content:

VAULT="path/to/your/obsidian/vault"
VAULT_DEV="path/to/your/dev/vault"

🎼 Languages

• English
• French To add a translation:
• Fork the repository
• Add the translation in the src/i18n/locales folder with the name of the language (ex: fr.json)
• Copy the content of the en.json file in the new file
• Translate the content
• Create a pull request

---

_{This plugin was generated by create-obsidian-plugin}