Skip to content

Frontmatter properties

Share Note reads and writes a handful of properties in a note's frontmatter. They all share a prefix, share by default, which you can change with the Frontmatter property prefix setting. If your prefix is pub, read pub_link wherever this page says share_link, and so on.

Written by the plugin

PropertyWhat it holds
share_linkThe address of the shared page, including the decryption key for encrypted notes. Its presence is how the plugin knows a note is shared: keep it to update or delete the share.
share_updatedWhen the note was last shared.

Both are removed again when you delete the shared note.

Set by you

Add these yourself to change how a single note is shared. Use the Checkbox type where shown; ticked means on.

A frontmatter property with the Checkbox type selected
PropertyTypeEffect
share_encryptedCheckboxEncrypt this note even if Share as encrypted by default is off.
share_unencryptedCheckboxShare this note unencrypted even if the default is encrypted. If both are ticked, share_encrypted wins.
share_expiresTextDelete the shared note after this long, for example 7 days. Overrides the default expiry. See Self-deleting notes.
share_sourceCheckboxInclude (ticked) or leave out (unticked) the Markdown source for this note, overriding the Include Markdown source setting. See Letting readers import your note.
share_titleTextThe title of the shared page, used when Note title source is set to Frontmatter property.