https://github.com/zakj/obsidian-link-address
Convert plain-text addresses in Obsidian notes to map links
https://github.com/zakj/obsidian-link-address
Last synced: 8 months ago
JSON representation
Convert plain-text addresses in Obsidian notes to map links
- Host: GitHub
- URL: https://github.com/zakj/obsidian-link-address
- Owner: zakj
- Created: 2024-08-11T23:30:28.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-12T00:23:01.000Z (almost 2 years ago)
- Last Synced: 2024-08-12T01:32:10.561Z (almost 2 years ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Link Address
Provides a command to replace the current selection in a note (which should be something like an address) with an Apple Maps link.
Includes the note's title as the `q` parameter for some context when opening.
## Releasing new releases
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
- Publish the release.
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
## Adding your plugin to the community plugin list
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
- Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo.
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
## 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`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
## API Documentation
See https://github.com/obsidianmd/obsidian-api