schihei/obsidian-unicode-formatter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README to document Remove Unicode Formatting command

Browse Source 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Heiko Joerg Schick
2026-03-21 15:06:49 +01:00
parent 1c86ac5740
commit 7a4e09f97c
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -3
View File
@@ -7,6 +7,7 @@ An [Obsidian](https://obsidian.md) plugin that transforms selected text into Uni
- **Unicode Bold** — converts letters and digits to sans-serif bold (𝗔𝗕𝗖 / 𝗮𝗯𝗰 / 𝟬𝟭𝟮) - **Unicode Bold** — converts letters and digits to sans-serif bold (𝗔𝗕𝗖 / 𝗮𝗯𝗰 / 𝟬𝟭𝟮)
- **Unicode Italic** — converts letters to sans-serif italic (𝘈𝘉𝘊 / 𝘢𝘣𝘤) - **Unicode Italic** — converts letters to sans-serif italic (𝘈𝘉𝘊 / 𝘢𝘣𝘤)
- **Unicode Bold Italic** — converts letters to sans-serif bold italic (𝘼𝘽𝘾 / 𝙖𝙗𝙘) - **Unicode Bold Italic** — converts letters to sans-serif bold italic (𝘼𝘽𝘾 / 𝙖𝙗𝙘)
- **Remove Unicode Formatting** — converts any formatted Unicode characters back to plain ASCII
- Non-mapped characters (punctuation, spaces, emoji, etc.) are passed through unchanged - Non-mapped characters (punctuation, spaces, emoji, etc.) are passed through unchanged
## Usage ## Usage
@@ -17,8 +18,9 @@ An [Obsidian](https://obsidian.md) plugin that transforms selected text into Uni
- **Format as Unicode Bold** - **Format as Unicode Bold**
- **Format as Unicode Italic** - **Format as Unicode Italic**
- **Format as Unicode Bold Italic** - **Format as Unicode Bold Italic**
- **Remove Unicode Formatting** — reverses any of the above back to plain ASCII
The selected text is replaced in place with its Unicode equivalent. The selected text is replaced in place.
## Installation ## Installation
@@ -47,8 +49,8 @@ npm run lint # ESLint check
| File | Purpose | | File | Purpose |
|------|---------| |------|---------|
| `src/unicode-maps.ts` | Builds character lookup maps from Unicode code point ranges | | `src/unicode-maps.ts` | Builds character lookup maps from Unicode code point ranges |
| `src/formatter.ts` | `transformText(text, style)` — maps each character through the selected style map | | `src/formatter.ts` | `transformText(text, style)` and `cleanText(text)` — character mapping functions |
| `src/commands.ts` | Registers the three editor commands with the Obsidian plugin API | | `src/commands.ts` | Registers the four editor commands with the Obsidian plugin API |
| `src/main.ts` | Plugin entry point — calls `registerCommands` on load | | `src/main.ts` | Plugin entry point — calls `registerCommands` on load |
### Unicode blocks used ### Unicode blocks used