Handy Toolkit

Handy Toolkit

中文说明

A handy toolkit for Obsidian reading and editing tweaks.

Features

1. Collapse Properties

• Collapse the properties area for the active file, including all open markdown views of the same file.
• Collapse properties for every Markdown note with valid YAML frontmatter in one operation.

2. First-Line Indentation

• Optionally apply first-line indentation in source mode and reading mode.

3. Quick Switcher Filtering

• Hide files under configured folders from quick switcher results.

4. Frontmatter Title Sync On Rename

• Optionally update the frontmatter title when a Markdown note is renamed.
• Optionally rename the matching attachment folder based on the Custom Attachment Location folder template; this setting is shown only after title sync is enabled.

5. Frontmatter Updated Sync On Modify

• Optionally update the frontmatter updated field when a Markdown note is modified.

6. Perlite Publish Status Toggle

• Toggle the active Markdown note between perlite_publish: true and no publish field with a command that can be assigned a hotkey.

7. Image Renaming

• Rename local image attachments in the active Markdown note according to their order in the note body.

8. Gitkeep Generation

• Create empty .gitkeep files for several predefined folder names used by the vault workflow.

Behavior

1. Collapse Properties

• Provides separate commands for the active file and all notes in the vault.
• When the same file is open in multiple markdown leaves, the plugin collapses properties in all of those open views.
• The bulk command skips notes without valid frontmatter and preserves existing heading, list, and other body folds.
• Fold state is stored only in Obsidian's local data on the current device. Markdown content is not modified, and the state is not synchronized through Git.
• In reading mode, the properties area collapses and updates immediately.
• In source mode, the plugin writes the collapsed state, but immediate visual refresh is not guaranteed by the public Obsidian API.
• If the internal metadata editor is unavailable, the plugin falls back to Obsidian's built-in toggle command for the active leaf.

2. First-Line Indentation

• Provides an optional first-line indentation enhancement, disabled by default.
• When first-line indentation is enabled, the plugin applies indentation in source mode and adapts reading-mode paragraphs separated by <br> so each split line can indent correctly.

3. Quick Switcher Filtering

• Can hide files in configured folders from quick switcher results. Paths are relative to the vault root and separated by commas.

4. Frontmatter Title Sync On Rename

• When enabled, renaming a Markdown note updates only the frontmatter title to the new filename.
• The first level 1 heading in the note body is not changed.
• When Sync matching attachment folder on rename is enabled, the plugin reads the enabled Custom Attachment Location settings and renders the old/new attachment folders from attachmentFolderPath values containing ${noteFilename}, ${notefilename}, or ${noteFileName}.
• For example, 00_assets/${noteFilename} renames 00_assets/Old note to 00_assets/New note when Old note.md is renamed to New note.md.
• If any current-note image attachment is outside the old matching folder, the plugin shows a notice and skips renaming the attachment folder.
• If Custom Attachment Location is missing, disabled, or unreadable, the plugin does not rename the attachment folder.

5. Frontmatter Updated Sync On Modify

• When enabled, modifying a Markdown note updates the frontmatter updated field with local time in YYYY-MM-DD HH:mm:ss format.
• If the existing updated value is within two minutes of the current time, the plugin skips writing it again to avoid repeated self-triggered updates.

6. Perlite Publish Status Toggle

• The command writes the YAML boolean perlite_publish: true when the active note is unpublished, and removes the field when it is published.
• Notes without valid frontmatter are left unchanged and produce a notice.
• The command only changes the publish field. It does not run the Perlite publisher or synchronize content to a server.

7. Image Renaming

• The command supports local wikilink and Markdown image links with common image extensions.
• Images are renamed in place as image-<timestamp>-<sequence>.<extension>, and the note links are updated to match.
• External images, block references, and image syntax inside fenced code blocks are not changed.

8. Gitkeep Generation

• The command creates missing .gitkeep files in 00_Inbox, 00_Moved, and Clippings.
• Existing .gitkeep files are skipped, and the command reports how many files were created or skipped.

Command

• Chinese UI: 折叠当前文件的属性
• Chinese UI: 折叠所有笔记的属性
• Non-Chinese UI: Collapse properties in current file
• Non-Chinese UI: Collapse properties in all notes
• Chinese UI: 切换当前文档发布状态
• Chinese UI: 按正文顺序重命名当前笔记图片
• Chinese UI: 为目录生成 .gitkeep 文件

Installation

• Copy the plugin into your vault's .obsidian/plugins/handy-toolkit directory.
• Enable the handy-toolkit community plugin in Obsidian.

Settings

• Enable first-line indentation: disabled by default.
• When enabled, the plugin applies the migrated indentation behavior internally, without requiring separate changes to Contextual Typography or Blue Topaz Custom.
• Quick switcher hidden folders: comma-separated vault-relative folder paths, such as Archive, Templates/private.
• Sync frontmatter title on rename: disabled by default.
• Sync matching attachment folder on rename: disabled by default; shown only after Sync frontmatter title on rename is enabled, and requires enabled Custom Attachment Location settings.
• Update updated field on modify: disabled by default.