obsidian-safe-filenames/README.md

# Obsidian Safe Filenames

https://forum.obsidian.md/t/some-invalid-filenames-prevent-syncing-on-android/87700

When you attempt to rename a file using characters that will break sync, this plugin automatically removes those characters from the filename.

## How to use

- Clone this repo.
- Make sure your NodeJS is at least v16 (`node --version`).
- `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode.

## Manually installing the plugin

- Copy over `main.js` and `manifest.json` to your vault `VaultFolder/.obsidian/plugins/safe-filenames/`.
update README 2025-01-18 12:57:28 -05:00			`# Obsidian Safe Filenames`
use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
update README 2025-01-18 12:57:28 -05:00			`https://forum.obsidian.md/t/some-invalid-filenames-prevent-syncing-on-android/87700`
use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
update README 2025-01-18 12:57:28 -05:00			`When you attempt to rename a file using characters that will break sync, this plugin automatically removes those characters from the filename.`
use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
Fix README headings (#29) 2022-05-07 11:15:23 -04:00			`## How to use`
use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
			`- Clone this repo.`
Update README.md 2023-07-25 15:17:26 -04:00			- Make sure your NodeJS is at least v16 (`node --version`).
			- `npm i` or `yarn` to install dependencies.
use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00			- `npm run dev` to start compilation in watch mode.

Fix README headings (#29) 2022-05-07 11:15:23 -04:00			`## Manually installing the plugin`
use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
change plugin path from sample 2025-01-18 12:58:50 -05:00			- Copy over `main.js` and `manifest.json` to your vault `VaultFolder/.obsidian/plugins/safe-filenames/`.