README file from
GithubSmart Accents Plugin
An Obsidian plugin designed for Italian writers and note-takers that automatically converts apostrophe-accented vowels (e.g., perche', citta', e') into proper Italian accented characters (perché, città, è) as you type.
✨ Features
- Smart Italian Accentuation:
- Automatically distinguishes between acute accents (
é) for conjunctions and compounds (perché,poiché,affinché,benché,finché,né,sé,ventitré, etc.) and grave accents (à, è, ì, ò, ù) for standard final vowels (città,è,così,però,più). - Fixes common grave-instead-of-acute typos (e.g., automatically converts
perchèorpoichèintoperchéandpoiché). - Preserves original casing (
Perche'→Perché,PERCHE'→PERCHÉ).
- Automatically distinguishes between acute accents (
- Elision & Truncated Words Protection:
- Leaves valid Italian elisions untouched (
un'amica,l'albero,d'accordo). - Protects apocopated/truncated words that strictly require an apostrophe instead of an accent (
po',va',da',fa',sta',di',be',mo').
- Leaves valid Italian elisions untouched (
- Context-Aware Exclusions:
- LaTeX Math: Ignores inline math (
$ ... $) and multi-line math blocks ($$ ... $$). - Code: Ignores inline code (
` ... `) and fenced code blocks (``` ... ```). - Links & URLs: Ignores Obsidian Wikilinks (
[[ ... ]]), Markdown links ([text](url)), and raw URLs (https://...).
- LaTeX Math: Ignores inline math (
- Mobile & Desktop Support: Works seamlessly across both desktop and mobile versions of Obsidian.
📝 Examples
| Typed | Result | Rule Applied |
|---|---|---|
perche' / perchè |
perché |
Acute accent (é) |
poiche' / poichè |
poiché |
Acute accent (é) |
citta' |
città |
Grave accent (à) |
E' vero |
È vero |
Capitalized grave accent (È) |
un po' |
un po' |
Protected truncated word |
l'altro |
l'altro |
Protected elision |
$x' + a'$ |
$x' + a'$ |
Ignored (LaTeX block) |
[[Nota citta']] |
[[Nota citta']] |
Ignored (Wikilink) |
🚀 Installation
From Obsidian Community Plugins (Recommended)
- Open Settings → Community plugins.
- Disable Restricted mode if enabled.
- Click Browse and search for Smart Accents.
- Click Install, then Enable.
Using BRAT (Beta Testing)
- Install the BRAT plugin from Community Plugins.
- Open BRAT settings and click Add Beta plugin.
- Enter the repository URL:
https://github.com/jomitrix/smart-accents-obsidian-plugin. - Enable Smart Accents in Community Plugins.
Manual Installation
- Download
main.jsandmanifest.jsonfrom the latest release. - Create a folder named
smart-accents-obsidian-plugininside your vault's.obsidian/plugins/directory. - Move the downloaded files into that folder.
- Reload Obsidian and enable the plugin in Settings → Community plugins.
🇮🇹 Descrizione in Italiano
Smart Accents Plugin è un plugin per Obsidian pensato per chi scrive in italiano con tastiere prive di lettere accentate (es. layout US/internazionale) o per velocizzare la digitazione.
Converte automaticamente le vocali seguite dall'apostrofo negli accenti corretti della lingua italiana:
- Accento acuto (
é) perperché,poiché,affinché,benché,finché,né,sé,ventitré, ecc. (correggendo anche eventualiperchèscritti con l'accento grave). - Accento grave (
à, è, ì, ò, ù) per tutte le altre parole tronche (città,però,così,più,è). - Rispetto delle regole grammaticali: non altera le elisioni (
un'idea,l'amico) né i troncamenti che richiedono l'apostrofo (po',va',da',fa',sta',di'). - Sicuro per formule e link: non interviene all'interno di blocchi matematici LaTeX (
$e$$), blocchi di codice, Wikilink ([[...]]) e collegamenti web.
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.