Skip to content

Commit f161b3a

Browse files
authored
Add Hyperlink section to docs (#363)
1 parent 72a7a62 commit f161b3a

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

DOCS.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@
1515
7. [Dot repeat](#dot-repeat)
1616
4. [Document Diagnostics](#document-diagnostics)
1717
5. [Tables](#tables)
18-
6. [Autocompletion](#autocompletion)
19-
7. [Abbreviations](#abbreviations)
20-
8. [Colors](#colors)
21-
9. [Advanced search](#advanced-search)
22-
10. [Notifications (experimental)](#notifications-experimental)
23-
11. [Clocking](#clocking)
24-
12. [Changelog](#changelog)
18+
6. [Hyperlinks](#hyperlinks)
19+
7. [Autocompletion](#autocompletion)
20+
8. [Abbreviations](#abbreviations)
21+
9. [Colors](#colors)
22+
10. [Advanced search](#advanced-search)
23+
11. [Notifications (experimental)](#notifications-experimental)
24+
12. [Clocking](#clocking)
25+
13. [Changelog](#changelog)
2526

2627
## Getting started with Orgmode
2728
To get a basic idea how Orgmode works, look at this screencast from [@dhruvasagar](https://github.com/dhruvasagar)
@@ -121,7 +122,7 @@ win_split_mode = 'tabnew'
121122

122123
Always open vertically:
123124
```
124-
win_split_mode = 'tabnew'
125+
win_split_mode = 'vsplit'
125126
```
126127

127128
Always open horizontally with specific height of 20 lines:
@@ -738,15 +739,7 @@ Toggle current line checkbox state
738739
Toggle current line to headline and vice versa. Checkboxes will turn into TODO headlines.
739740
#### **org_open_at_point**
740741
*mapped to*: `<Leader>oo`<br />
741-
Open hyperlink or date under cursor.<br />
742-
Hyperlink types supported:
743-
* URL (http://, https://)
744-
* File (starts with `file:`. Example: `file:/home/user/.config/nvim/init.lua`) Optionally, a line number can be specified
745-
using the '+' character. Example: `file:/home/user/.config/nvim/init.lua +10`
746-
* Headline title target (starts with `*`)
747-
* Headline with `CUSTOM_ID` property (starts with `#`)
748-
* Fallback: If file path, opens the file, otherwise, tries to find the Headline title.
749-
When date is under the cursor, open the agenda for that day.<br />
742+
Open hyperlink or date under cursor. When date is under the cursor, open the agenda for that day.<br />
750743
#### **org_edit_special**
751744
*mapped to*: `<Leader>o'`<br />
752745
Open a source block for editing in a temporary buffer of the associated `filetype`.<br />
@@ -969,6 +962,18 @@ And going to line `4` and pressing `gqgq`, it will format it to this:
969962
| col 1 | col 2 |
970963
```
971964

965+
## Hyperlinks
966+
967+
The format for links is either `[[LINK]]` or `[[LINK][DESCRIPTION]]`. If a description is provided, the actual link is concealed in favor of the description.
968+
969+
Hyperlink types supported:
970+
* URL (http://, https://)
971+
* File (starts with `file:`. Example: `file:/home/user/.config/nvim/init.lua`) Optionally, a line number can be specified
972+
using the '+' character (Example: `file:/home/user/.config/nvim/init.lua +10`) or a headline within the specified file using '::' (Example: `file:/home/user/org/file.org::*Specific Headline`)
973+
* Headline title target within the same file (starts with `*`)
974+
* Headline with `CUSTOM_ID` property within the same file (starts with `#`)
975+
* Fallback: If file path, opens the file, otherwise, tries to find the headline title.
976+
972977
## Autocompletion
973978
By default, `omnifunc` is provided in `org` files that autocompletes these types:
974979
* Tags

0 commit comments

Comments
 (0)