Skip to content

Commit 001adea

Browse files
committed
Update readme
1 parent 4b0150c commit 001adea

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is a plugin for [Obsidian](https://obsidian.md).
44

55
## Description
66

7-
This plugin automatically sets the display text of links to headings of other notes to be the name of the heading instead of showing the link text as it appears. So, instead of:
7+
This plugin automatically sets the display text of anchor links (links to a heading of another note) to be the name of the heading instead of showing the link text as it appears. So, instead of:
88

99
``` Markdown
1010
[[Title#Heading]]
@@ -16,13 +16,24 @@ The link will automatically update to:
1616
[[Title#Heading|Heading]]
1717
```
1818

19-
This provides a nice appearance but saves the time of manually setting the display text, especially if you use tab to autocomplete the link (when you autocomplete, you have to navigate back in front of the brackets, add the vertical bar, and then type the heading name).
19+
This provides a nicer appearance while saving the time of manually setting the display text, especially if you use tab to autocomplete the link, because when you autocomplete, you have to navigate back in front of the brackets, add the vertical bar, and then type the heading name.
2020

2121
## Features
2222

23-
In the settings for this plugin, you can specify the format of the display text:
23+
The goal of this plugin is to be useful for regardless of one's personal note taking style. That is why in the settings you can specify the format of the display text:
2424

2525
``` Markdown
2626
Just the heading (default): [[Title#Heading|Heading]]
27-
The heading and note name: [[Title#Heading|Title Heading]]
27+
The heading followed by the note name: [[Title#Heading|Title Heading]]
28+
The note name followed by the setting: [[Title#Heading|Heading Title]]
2829
```
30+
31+
This plugin works the same way for anchor links containing multiple headings. This behavior can be changed too:
32+
33+
``` Markdown
34+
Show all headings (default): [[Title#Heading#Subheading#Subsubheading|Heading Subheading Subsubheading]]
35+
Show only the first heading: [[Title#Heading#Subheading#Subsubheading|Heading]]
36+
Show only the last heading: [[Title#Heading#Subheading#Subsubheading|Subsubheading]]
37+
```
38+
39+
By default, the headings in the display text will be separated by a single space, but this can be changed to whatever you prefer. Some examples may be a comma (, ), colon (: ), or arrow (-> ). Just not that whatever is typed in the separator text box in the settings will be exactly what is used in the display text, nothing is added to it or removed from it.

0 commit comments

Comments
 (0)