docs: number demo vault example notes

This commit is contained in:
Michael Naumov 2026-07-20 09:04:54 -06:00
parent 9c8683e37b
commit 494e0ba33a
8 changed files with 13 additions and 13 deletions

View file

@ -4,15 +4,15 @@ Welcome to the [Smart Rename](https://github.com/mnaoumov/obsidian-smart-rename/
> [!TIP] Interactive buttons
>
> The two setup notes have **Run** buttons, powered by [`CodeScript Toolkit`](https://github.com/mnaoumov/obsidian-codescript-toolkit/), which this vault installs for you automatically on first open (see [[CodeScript Toolkit prerequisite]]). Renaming itself is a manual command, so the feature notes have no buttons.
> The two setup notes have **Run** buttons, powered by [`CodeScript Toolkit`](https://github.com/mnaoumov/obsidian-codescript-toolkit/), which this vault installs for you automatically on first open (see [[05 CodeScript Toolkit prerequisite]]). Renaming itself is a manual command, so the feature notes have no buttons.
## Feature
- [[Smart rename]]
- [[Invalid characters]]
- [[Settings]]
- [[01 Smart rename]]
- [[02 Invalid characters]]
- [[03 Settings]]
## Setup
- [[Code buttons check]]
- [[CodeScript Toolkit prerequisite]]
- [[04 Code buttons check]]
- [[05 CodeScript Toolkit prerequisite]]

View file

@ -13,8 +13,8 @@ Smart Rename renames the **active note** and rewrites its backlinks so their **d
## What it preserves
- **Note links** - a bare `[[Rename me]]` becomes `[[Renamed note|Rename me]]`, keeping the old text visible (controlled by the note-links setting in [[Settings]]).
- **Note links** - a bare `[[Rename me]]` becomes `[[Renamed note|Rename me]]`, keeping the old text visible (controlled by the note-links setting in [[03 Settings]]).
- **Frontmatter links** - links inside YAML frontmatter get the same treatment (controlled by the frontmatter-links setting).
- **The first header and a title key** - optionally kept in sync with the new name (see [[Settings]]).
- **The first header and a title key** - optionally kept in sync with the new name (see [[03 Settings]]).
Renaming to a title that contains characters Obsidian cannot use in a filename is handled separately - see [[Invalid characters]].
Renaming to a title that contains characters Obsidian cannot use in a filename is handled separately - see [[02 Invalid characters]].

View file

@ -16,4 +16,4 @@ Some characters (like `:` `/` `\` `*` `?`) cannot appear in a file name. Smart R
- **Remove** - strip the invalid characters from the file name.
- **Replace** - swap each invalid character for the configured replacement character (default `_`).
When the invalid title is stored as the note's display text (so the reader still sees `Chapter 1: Beginnings` even though the file name is sanitized) is controlled by the store-invalid-title setting. See [[Settings]] for all of these keys.
When the invalid title is stored as the note's display text (so the reader still sees `Chapter 1: Beginnings` even though the file name is sanitized) is controlled by the store-invalid-title setting. See [[03 Settings]] for all of these keys.

View file

@ -2,7 +2,7 @@
# Code buttons check
If [`CodeScript Toolkit`](https://github.com/mnaoumov/obsidian-codescript-toolkit/) is installed and enabled, the block below renders as a **Run** button. Click it - a notice should appear. If you only see a code block, install the prerequisite first: [[CodeScript Toolkit prerequisite]].
If [`CodeScript Toolkit`](https://github.com/mnaoumov/obsidian-codescript-toolkit/) is installed and enabled, the block below renders as a **Run** button. Click it - a notice should appear. If you only see a code block, install the prerequisite first: [[05 CodeScript Toolkit prerequisite]].
```code-button
---

View file

@ -2,6 +2,6 @@
# Rename me
This is the note the [[Smart rename]] demo renames. With this note active, run **Smart Rename: Invoke** and give it a new title.
This is the note the [[01 Smart rename]] demo renames. With this note active, run **Smart Rename: Invoke** and give it a new title.
Two notes link here - [[References/Note A]] and [[References/Note B]]. After the rename, their links will keep showing "Rename me" as their display text instead of switching to the new name.

View file

@ -12,7 +12,7 @@ registerDemoVaultCoverageSuite({
configInterfaces: [{ interfaceName: 'PluginSettings', sourcePath: 'src/plugin-settings.ts' }],
interfaces: [],
nonTrivialGuard: {
expectDemoNote: 'Settings.md',
expectDemoNote: '03 Settings.md',
expectMember: 'invalidCharacterAction',
interfaceName: 'PluginSettings',
sourcePath: 'src/plugin-settings.ts'