Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mnaoumov/obsidian-better-markdown-links
https://github.com/mnaoumov/obsidian-better-markdown-links
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/mnaoumov/obsidian-better-markdown-links
- Owner: mnaoumov
- License: mit
- Created: 2024-07-10T15:44:52.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T03:37:07.000Z (3 months ago)
- Last Synced: 2024-09-18T06:29:21.124Z (3 months ago)
- Language: TypeScript
- Size: 1.17 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Better Markdown Links
This is a plugin for [Obsidian] that adds support for `angle bracket` links and manages relative links properly.
## Angle Bracket Links
Markdown links `[Title](path/to/note.md)` are better for compatibility purposes as `[[Wikilink]]` is not part of the Markdown spec.
However, links with spaces `[Title](path%20with%20space/note%20with%20space.md)` are quite unreadable.
The Markdown spec allows more readable links `[Title]()`, which work fine in [Obsidian], but [Obsidian] doesn't generate such `angle bracket` links.
This plugin makes [Obsidian] generate `angle bracket` links.
## Relative Links
There is a [problem](https://forum.obsidian.md/t/add-settings-to-control-link-resolution-mode/69560) in [Obsidian] where relative paths might be incorrectly resolved as absolute paths, causing the same link to behave differently in [Obsidian] and other Markdown editors.
This plugin ensures that relative paths are prepended with `./`, e.g., `[Title](./path/to/note.md)`, to overcome the above-mentioned problem.
## Link Conversion
This plugin adds the ability to convert all links in an individual note or the entire vault.
## Automatic Link Conversion
This plugin adds the ability to automatically convert all new links entered manually to the selected format.
## Automatic handling rename/move
This plugin adds the ability to automatically update links to the renamed or moved to another directory files.
To improve performance, consider installing [Backlink Cache](https://obsidian.md/plugins?id=backlink-cache) plugin.
## Extend [`app.fileManager.generateMarkdownLink()`][generateMarkdownLink]
This plugin enhances the [`app.fileManager.generateMarkdownLink()`][generateMarkdownLink] function by adding an [additional overload](./types.d.ts).
If you want to use the updated functions from your plugin, you can copy [types.d.ts](./types.d.ts) into your code.
**Note**: The plugin's setting `Ignore incompatible Obsidian settings` sets the default value of `isWikilink` to `false`.
## Installation
- `Better Markdown Links` is available in [the official Community Plugins repository](https://obsidian.md/plugins?id=better-markdown-links).
- Beta releases can be installed through [BRAT](https://obsidian.md/plugins?id=obsidian42-brat).
## License
© [Michael Naumov](https://github.com/mnaoumov/)
[Obsidian]: https://obsidian.md/
[generateMarkdownLink]: https://github.com/obsidianmd/obsidian-api/blob/ea526e2459ad3f188c994862a9b106d94bf0f692/obsidian.d.ts#L1435