From 361c82839e2506e4006ba56dac95c80deac15336 Mon Sep 17 00:00:00 2001 From: Lex Toumbourou Date: Tue, 11 Apr 2023 23:58:30 +1000 Subject: [PATCH] Release ready version. --- README.md | 56 +++++++++++++++++++-------------------------------- manifest.json | 20 +++++++++--------- 2 files changed, 32 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 1158863..e84b7ac 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,33 @@ # Title As Link Text - https://user-images.githubusercontent.com/1080552/230809814-ff8bc224-1455-420c-b363-a0d071ff801c.mp4 -## WARNING - -This software is still being tested and will likely mess up your files. **Only use if you have a backup of your vault.** - ## Overview Title As Link Text is an [Obsidian](https://obsidian.md/) plugin that automatically updates Markdown-style links with the page's title instead of the file name. -## Requirements - -1. `[[Wikilinks]]` are turned off. -2. I recommend using either `absolute` or `relative` style links for nested file structures. +For this plugin to be useful, use Markdown links by setting off `Use [[Wikilinks]]`. ## Complementary Plugins -* [Wikilinks To Markdown](https://github.com/agathauy/wikilinks-to-mdlinks-obsidian) to convert existing Wikilinks to Markdown. -* [Front Matter Title](https://github.com/snezhig/obsidian-front-matter-title) to replace the title with filename throughout Obsidian. +- [Wikilinks To Markdown](https://github.com/agathauy/wikilinks-to-mdlinks-obsidian) to convert existing Wikilinks to Markdown. +- [Front Matter Title](https://github.com/snezhig/obsidian-front-matter-title) to replace the title with filename throughout Obsidian. ## Use cases -* Use traditional Zettelkasten-style IDs for filenames **20230408102501.md** -* Allow special characters in the page's title that would otherwise not work in the filename (`?`, `,` etc.) +- Use traditional Zettelkasten-style IDs for filenames **20230408102501.md** +- Allow special characters in the page's title that would otherwise not work in the filename (`?`, `,` etc.) ## Installation Installation via BRAT (for pre-releases or betas) -* Install [BRAT](https://github.com/TfTHacker/obsidian42-brat). -* Add "Title As Link Text" to BRAT: - * Open "Obsidian42 - BRAT" via Settings → Community Plugins - * Click "Add Beta plugin." - * Use the repository address `lextoumbourou/obsidian-title-as-link-text` - * Enable "Title As Link Text" under Settings → Options → Community Plugins +- Install [BRAT](https://github.com/TfTHacker/obsidian42-brat). +- Add "Title As Link Text" to BRAT: + - Open "Obsidian42 - BRAT" via Settings → Community Plugins + - Click "Add Beta plugin." + - Use the repository address `lextoumbourou/obsidian-title-as-link-text` + - Enable "Title As Link Text" under Settings → Options → Community Plugins ## How It Works @@ -53,43 +45,37 @@ The plugin infers the title as follows: 1\. Look for `title` in the frontmatter, if it exists: -* File name: **some-doc.md** -* File contents +- File name: **some-doc.md** +- File contents ``` --- title: Some Doc --- ``` -* Link result: `[Some Doc](./some-doc.md)` +- Link result: `[Some Doc](./some-doc.md)` 2\. Use the first `# H1` on the page if it exists. -* File name: **path/to/another-doc.md** -* File contents: +- File name: **path/to/another-doc.md** +- File contents: ``` # Another Doc ``` -* Link result: `[Another Doc](path/to/another-doc.md` +- Link result: `[Another Doc](path/to/another-doc.md` 3\. Use the file name. -* File name: **no-title.md** -* File contents: +- File name: **no-title.md** +- File contents: ``` No title in this file. ``` -* Link result: `[no-title](no-title.md)` +- Link result: `[no-title](no-title.md)` ## Comands -* `Update All Links` can be used to add the title as link text to all existing Markdown links in your vault. +- `Update All Links` can be used to add the title as link text to all existing Markdown links in your vault. ## License MIT - -## To Do - -* [ ] Add command to process a Vault. -* [ ] Add unit tests. -* [ ] Much more testing. diff --git a/manifest.json b/manifest.json index 6a2b7db..df5cf2f 100644 --- a/manifest.json +++ b/manifest.json @@ -1,11 +1,13 @@ { - "id": "obsidian-title-as-link-text", - "name": "Title As Link Text", - "version": "1.0.5", - "minAppVersion": "0.15.0", - "description": "This plugin improves the behaviour of Markdown-style links in Obsidian.", - "author": "Lex Toumbourou", - "authorUrl": "https://notesbylex.com", - "fundingUrl": "https://obsidian.md/pricing", - "isDesktopOnly": false + "id": "obsidian-title-as-link-text", + "name": "Title As Link Text", + "version": "1.0.6", + "minAppVersion": "0.15.0", + "description": "Use the title as link text for Markdown links.", + "author": "Lex Toumbourou", + "authorUrl": "https://notesbylex.com", + "fundingUrl": { + "Buy Me a Coffee": "https://www.buymeacoffee.com/lext" + }, + "isDesktopOnly": false }