You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-4Lines changed: 15 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This is a plugin for [Obsidian](https://obsidian.md).
4
4
5
5
## Description
6
6
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:
8
8
9
9
```Markdown
10
10
[[Title#Heading]]
@@ -16,13 +16,24 @@ The link will automatically update to:
16
16
[[Title#Heading|Heading]]
17
17
```
18
18
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.
20
20
21
21
## Features
22
22
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:
24
24
25
25
```Markdown
26
26
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]]
28
29
```
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