Skip to content

Links, wikilinks, and images

Type a link and it comes alive as you finish typing it. Two syntaxes work side by side — standard [text](path) and Obsidian-style [[wikilinks]].

Type [text](url). The link forms the moment you type the closing ).

[Release notes](./releases/1.0.md)
[Inkstone](https://inkstone.app)

To link words you have already written, select them and choose Insert > Link (Opt+Cmd+K). Your selection becomes the link text; put the caret inside it to fill in the address. With nothing selected you get the word link, selected, to type over.

  • Type a full web address — one starting with http:// or https:// — and press space.
  • Paste a URL with nothing selected and it arrives as a link.
  • Paste a URL over selected text and your words become the link text.

A URL you type inside a code block, or between backticks, stays plain text. Move it out of the code and it becomes a link.

Type [[ and pick the file from the list that appears, or write the target yourself:

[[Project Plan]]
[[Project Plan|the plan]]
[[Project Plan#Milestones]]
[[#Milestones]]

Before the | is the file you are pointing at; after it is what the reader sees. Add # and a heading to land on that heading. Leave the file out and you jump around inside the note you are already in.

The name on its own is enough — Inkstone finds the file anywhere in your workspace, with or without the .md, and it forgives capitals, hyphens, and underscores: [[my note]] finds My-Note.md. When two files share a name, add enough of the folder to tell them apart: [[attachments/photo.png]].

Four things you can type open the same list of files:

You type You get
[[ A wikilink
![[ A file shown in the document
[text]( A markdown link, with a path relative to this file
![alt]( A file shown in the document, same relative path

Keep typing to narrow the list. Part of the name first, then part of the folder — decarch finds decisions.md in your architecture folder.

Action Key
Move through the list Up / Down
Insert the file Return or Tab
Dismiss the list Esc

After [text]( or ![alt]( you can type an address instead of picking a file. A web address, an email address, or a phone number gives you a single External link row that uses exactly what you typed.

Cmd+Click it. Hold Cmd and the pointer turns into a hand over links.

Destination What happens
A web, mail, or phone address Opens in the default app
A markdown or text file Opens in a tab
An image, video, audio file, or PDF Opens in a viewer tab
Anything else Opens the way double-clicking it in Finder would

A #heading on the end scrolls the file you land on to that heading. Both spellings work: #Setup Steps and #setup-steps.

Destinations that open inside Inkstone get a new tab. To reuse the current tab instead, turn off Open links in new tab in Settings > General > Editing.

Put the caret inside the link and a popover appears over it. The tabs along its top pick what the field below edits:

  • Display — the words the reader sees (Alt on an image).
  • Link — where it points. Click the field and the file list opens below it.
  • Size — a width in pixels, or 300x200. Images and video only.
  • Raw — the whole link as markdown, to edit by hand. Press Return to apply.

Two buttons finish that row: one opens the destination in a new tab, the other removes the link.

Put a ! in front of the link: ![[file]], or ![alt](path) for a relative path. What you see depends on the file:

File Shown as
Image The image
Video, audio A player with controls
PDF The PDF, scrollable — click the name bar above it to select the embed
Anything else, including notes A small chip with the file’s name

Set a size after a |, the way Obsidian writes it:

![[diagram.png|400]]
![[diagram.png|400x300]]
![[diagram.png|autox300]]

A number on its own is the width in pixels. Two numbers are width by height. Write auto in place of the width and the picture keeps its proportions at the height you asked for.

Open a PDF at a particular page with ![[report.pdf#page=3]].

If Inkstone can’t find the file, you see its name where the file would be. Add the file, then reopen the document and it appears.

Save the document before you drag a video in. Dropped into a document you have never saved, a video doesn’t appear; save first and it lands. Images show up either way.

Drag the file into the editor, or paste it from the clipboard. It lands as its own block below the line the caret is on.

The first time media arrives in a workspace, Inkstone asks once where such files should go, and uses your answer from then on:

  • Beside the document
  • A subfolder beside the document
  • In one folder you choose

To change the answer later, right-click the workspace in the sidebar and choose Media Settings… — see [[sidebar-workspaces-and-file-types|Sidebar, workspaces, and file types]].

A picture that already lives in your workspace is linked where it sits, so you don’t end up with a second copy of it.

Drag either handle on an image that sits alone on its line; the new width sticks when you let go. An image mixed into a line of text has no handles — put it on a line of its own to get them. To take a width off again, clear the Size field in the popover.