Links, images and callouts

Links#

Select some text and press ⌘K (Insert ▸ Link…). Start typing a page or heading name — or paste a web address — and press Return.

• With nothing selected, ⌘K inserts a link whose text is the page’s or heading’s title.
• Type [[ anywhere in the text for the same search inline.
• Links are written as paths relative to the page, with #anchor for a heading — for example [Rollback](../engineering/release-checklist.md#on-release-day). Anchors follow GitHub’s rules, so links work on GitHub too.
• ⌘K with the caret in a link shows its card: Open, Change Destination…, Edit Text and Remove Link.

A click in a link places the caret, so you can edit its text. ⌘-click follows it. Hover a link for half a second for its card — where it goes, with Open, Edit Link, Copy (the destination as written) and Unlink. Links to web pages show ↗ and open in your browser. On a Read Only page and in Preview, a click follows a link, ⌘-click opens it in a new tab and ⌥-click in a new window.

Pasting a web address over selected text links the text to it; pasted on its own, the address becomes a link that shows the address.

A link whose page can’t be found is underlined with a red dotted line, and its card offers Choose New Destination…. When you rename or move a page in Kirbon, links to it are updated for you.

Images and files#

Drag images or files from Finder onto the page, paste them, or choose Insert ▸ Image… or Insert ▸ File…. Kirbon copies each file into assets/<page>/ next to your pages — originals are never moved — and shows progress while it copies. Images appear as images; other files as file chips with their type and size.

Click an image to select it. Its toolbar has:

• Size — Fit Width, 75 %, 50 % or Original; or drag a corner handle to resize in 5 % steps;
• Alt Text… — read by VoiceOver and shown if the image can’t load;
• Caption — a line of text under the image;
• Replace…, Open Original, and ⋯ for Remove from Page, Show in Finder and Copy Image.

Press Space on a selected image or file chip to see it in Quick Look; double-click a file chip to open it in its app. ⌫ removes it from the page, ⌘C copies its Markdown.

Removing an image from a page keeps its file in assets/ — Undo brings it back. A missing image shows its name with Locate….

When a file with the same name is already in the page’s attachments, Kirbon asks: Keep Both, Use Existing File or Replace….

Callouts#

Callouts are coloured boxes for notes and warnings. Kirbon saves them as GitHub alerts, so they look the same on GitHub.

Insert one from the / menu or Insert ▸ Callout. The type button in a callout’s corner changes its type, and offers Remove Callout Style — Keep Text and Delete Callout and Its Text.