Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xavdid/obsidian-golinks
Turn go/links into clickable elements in Obsidian
https://github.com/xavdid/obsidian-golinks
obsidian obsidian-md obsidian-plugin
Last synced: about 1 month ago
JSON representation
Turn go/links into clickable elements in Obsidian
- Host: GitHub
- URL: https://github.com/xavdid/obsidian-golinks
- Owner: xavdid
- License: mit
- Created: 2022-06-29T03:57:43.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T08:02:27.000Z (8 months ago)
- Last Synced: 2024-06-17T22:48:08.005Z (3 months ago)
- Topics: obsidian, obsidian-md, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 133 KB
- Stars: 11
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - xavdid/obsidian-golinks - Turn go/links into clickable elements in Obsidian (TypeScript)
README
# Obsidian GoLinks
This is a simple [Obsidian](https://obsidian.md) plugin for rendering plaintext [GoLinks](https://www.golinks.io/) (like go/links) so that they're clickable.
## Demo
```markdown
This plugin renders plaintext go/links as clickable! It ignores links in `go/backticks` and links that have already been [go/linkified](http://go/linkified).
> It also works in go/blockquotes, and...
- it
- works
- in
- go/lists!
- neat, right?
```
## Installation
### Easiest: Plugin Directory
This plugin can be installed from the [Obsidian Plugins directory](https://obsidian.md/plugins?search=golinks)!
You can also click this link to open the page directly in Obsidian: https://obsidian.md/plugins?id=obsidian-golinks
### Medium: From Releases
1. create the `path/to/your/vault/.obsidian/plugins/obsidian-golinks` folder
1. go to the latest [GitHub release](https://github.com/xavdid/obsidian-golinks/releases)
1. download the `main.js` and `manifest.json`
1. move both of those files to the folder created in step 1
1. in Obsidian settings, enable the plugin like normal
### Most Involved: Build From Source
1. clone this repo into `path/to/your/vault/.obsidian/plugins/obsidian-golinks`
2. in that folder install dependencies by running `yarn`
3. build w/ `yarn build`
4. in Obsidian settings, enable the plugin like normal
## Considerations
There is no risk of data loss when using this plugin. As it only acts on the markdown rendering process, the worst it can do is make your reading view not show some of your text (or show it incorrectly). If this happens, disable the extension and please file [an issue](https://github.com/xavdid/obsidian-golinks/issues).
No data is sent off your machine, so this plugin is perfectly safe to use in corporate contexts. It's basically just some regex.
## Releasing New Versions
- 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`