Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flytaly/linksyncer
markdown link synchronizer
https://github.com/flytaly/linksyncer
go markdown
Last synced: about 2 months ago
JSON representation
markdown link synchronizer
- Host: GitHub
- URL: https://github.com/flytaly/linksyncer
- Owner: flytaly
- License: mit
- Created: 2022-05-20T20:36:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-03T15:24:07.000Z (6 months ago)
- Last Synced: 2024-10-15T20:41:16.349Z (3 months ago)
- Topics: go, markdown
- Language: Go
- Homepage:
- Size: 1.31 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown Link Synchronizer
## linksyncer
This is a command-line utility that helps you organize your Markdown files. It tracks and updates the links in your .md notes.
## Installation (with Go)
[Go](https://go.dev/dl/) should be installed in the system.
```bash
go install github.com/flytaly/linksyncer@latest
```
## Usage
### Caution
**Before using, back up your notes or use version control systems such as Git in case something goes wrong.**
### Running in manual mode
1. In the root directory of your notes, run `linksyncer`. It will search for all files and nested directories with notes.
2. Rename or move files and images in the nested directories.
3. Press `Enter` to check for changes and then `y` (or `Enter` again) to automatically modify paths in the `.md` files.
```bash
linksyncer
```
### Running in watch mode
You can run `linksyncer` in "watch mode" so it will automatically check for changes and update links.
However, **try not to use the watch mode in folders with a huge number of files**, such as your home directory.
```bash
linksyncer watch
```
## Supported link formats
- `[note](./note1.md)`
- ``
- `
`
## Flags and Commands
```
-l, --log string path to the log file
-p, --path string path to the watched directory (default is the working directory)
--size int maximum file size in KB (default 1024)
-v, --version version for linksyncer
```
## Example
