Notes and properties

Notes and properties

Create a note and it becomes a page. Properties handle the rest.

To create a page, create a note in the right folder. Properties (the block at the top of the note, between --- lines) are optional and control how it shows up.

  • In Blup Studio: click New note (or Ctrl+N) and fill in the Properties panel, above the text. See Note properties.
  • By hand: type --- on the first line, write the properties and close the block with another ---.

On every page

PropertyWhat it’s for
titlePage title. Without it, the note’s name is used.
linkTitleShort title for menus and cards.
descriptionSummary in lists, on Google and on social media.
weightOrder in the side menu and in lists: lower comes first.
drafttrue keeps the note off the site (it only shows in the preview).
hiddentrue publishes it, but takes it out of lists and asks Google not to show it.
passwordProtects the page with a password. See Passwords and hidden pages.

In blog posts and the changelog

PropertyWhat it’s for
dateDate. Without it, created is used.
updatedDate of the last update.
tagsTopics; each tag gets its own page.
imageCover, like "[[my-cover.jpg]]".
authorsWho wrote it, like [Ana, Bruno].
featuredtrue picks the featured post.

In the roadmap and the help center

PropertyWhat it’s for
statusRoadmap column: planned, in progress or done.
categoryThe card’s label on the roadmap.
iconIcon of a help center collection (in its _index).

Filled in by Blup on its own

PropertyWho fills it in
audio, audio_hash, audio_secondsNarration. See Post narration.
translationKey, translation_hash, ai_translatedTranslation. See Multilingual sites.
created, updatedThe Studio, in vault notes.

Ready-made templates

Sites created from the command line get a Templates folder, with templates for a docs page, a roadmap item and a changelog version. Copy one to start a note with the right properties.