https://github.com/louanfontenele/obsidian-vault-file-renamer
Vault File Renamer: Automatically standardizes file names to GitHub style (lowercase, no accents, only -, ., _) while preserving folder structure and file contents.
https://github.com/louanfontenele/obsidian-vault-file-renamer
obsidian obsidian-community obsidian-md obsidian-plugin obsidianmd
Last synced: 2 months ago
JSON representation
Vault File Renamer: Automatically standardizes file names to GitHub style (lowercase, no accents, only -, ., _) while preserving folder structure and file contents.
- Host: GitHub
- URL: https://github.com/louanfontenele/obsidian-vault-file-renamer
- Owner: louanfontenele
- License: 0bsd
- Created: 2025-02-24T17:48:27.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2025-02-24T18:48:42.000Z (2 months ago)
- Last Synced: 2025-02-24T19:22:36.461Z (2 months ago)
- Topics: obsidian, obsidian-community, obsidian-md, obsidian-plugin, obsidianmd
- Language: TypeScript
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vault File Renamer 🔧🚀
**Vault File Renamer** is an Obsidian plugin that automatically standardizes the names of your vault files! It converts filenames to lowercase, removes accents, and ensures a consistent naming style that matches GitHub's conventions.
---
## ✨ Features
- **Automatic Renaming:**
Automatically renames files when created or renamed manually.
- **Consistent Naming:**
Converts filenames to lowercase, removes accents, and replaces spaces with dashes (`-`).
- **Customizable Format:**
Only allows lowercase letters, numbers, and the symbols `-`, `_`, and `.`. Any disallowed character is converted to a dash.
- **Path Preservation:**
Keeps your files in their original folders, so no work is lost!
---
## 📥 Installation
1. **Clone or download** this repository.
2. Run `npm install` in the plugin folder to install dependencies.
3. Build the plugin using:
```bash
npm run build production
```
4. Copy the generated `main.js` and `manifest.json` to your Obsidian plugins folder (usually located at `.obsidian/plugins/vault-file-renamer`).
5. Open Obsidian, go to **Settings → Community Plugins**, and enable **Vault File Renamer**.
---
## 🚀 Usage
- **Automatic Standardization:**
The plugin will automatically rename all existing files in your vault when activated and apply the same renaming rules for new files or manual renames.
- **No More Duplicates:**
It checks for duplicates and avoids creating empty or duplicate files.
Enjoy a tidier vault with standardized filenames! 🎉
---
## 🛠️ Development
To set up the development environment:
1. **Install Dependencies:**
```bash
npm install
```
2. **Watch for Changes (Development Mode):**
```bash
npm run watch
```
3. **Build for Production:**
```bash
npm run build production
```
Feel free to contribute and open issues if you find any bugs or have feature requests!
---
## 🙏 Credits
Developed with ❤️ by [Louan Fontenele](https://github.com/louanfontenele).
Inspired by the [Obsidian Sample Plugin](https://github.com/obsidianmd/obsidian-sample-plugin).
---
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.