Docs

Mentions and attachments

Two inline forms link platform objects from prose: @handle links a person, :attach[...] links a file uploaded to the publication.

Mentions

Write @ followed by a handle:

The construction follows an idea of @emmynoether.

A mention renders as a link to that profile. The rules:

  • Only handles that resolve to a real profile at publish time become links; anything else stays plain text. Renaming heals: if the person later changes their handle, existing mentions follow them.
  • A handle is 3-30 characters: lowercase letters, digits, and single underscores between runs (ada_lovelace). Case is ignored – @Ada_Lovelace mentions ada_lovelace.
  • An @ inside an email address (ada@example.org) is never a mention.
  • To show a literal @handle without linking, wrap it in `inline code`.

Mentions are for pointing readers at a person – collaborators, acknowledgements. Authorship and formal attribution use the publication's author fields, not mentions in the text.

Files uploaded to a publication (data sets, slides, PDFs) can be linked inline as a chip:

Full derivation in :attach[the appendix]{#0198a3f2-7c41-7000-8000-1f2e3d4c5b6a}.
  • The [label] is the visible link text; the {#...} is the attachment's id.
  • The chip opens in a new tab: the browser previews what it can (images, PDF) and downloads the rest. Access follows the publication's visibility – a reader who can see the page can open its attachments.
  • The id must belong to an attachment of this publication. In practice you never type this syntax: the editor inserts the chip when you upload or pick a file, and manages the id for you.

For images that should display in the page rather than link, use image syntax or a figure.