Skip to content

Commit 2390743

Browse files
committed
Add documentation for the fileLink directive
1 parent 1d7e037 commit 2390743

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/markdown-options.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,24 @@ If a user clicks this "Save file" button, a `compose.yaml` file will be created
8282

8383
By default, all links are configured to open new browser tabs when clicked.
8484

85+
### Opening links as a tab
86+
8587
If you want to add another tab to the right-hand panel, you can use the following directive:
8688

8789
::tabLink[Link text]{href="http://localhost:3000" title="Tab title"}
8890

8991
This will render a link with the visible text of "Link text" pointing to "http://localhost:3000". When clicked, a new tab will be created with the title of "Tab title".
92+
93+
94+
### Opening files in the IDE
95+
96+
If you want to create a link that will open a project file in the IDE, you can use the following directive:
97+
98+
Open the :fileLink[compose.yaml]{path="compose.yaml"} file ...
99+
100+
Directive arguments include:
101+
102+
- **path** - the full path _from the root of the project_ of the file to open
103+
- **line** (optional) - the line number (1-based) to put the cursor on
104+
105+
The body (text inside the `[]`) is what will be displayed to the user.

0 commit comments

Comments
 (0)