Docs
Everything about Blup, from installing to publishing.
Blup turns your notes into a fast site, and it also keeps notes just for you, in note vaults. The recommended way to use it is Blup Studio, the app for your computer (Linux, macOS and Windows): you write, see the site preview beside the text and publish with one button.
The notes are plain Markdown files, so any text editor opens them too. To build and publish without the Studio, there is the blup command line. On the phone, Blup Notes keeps your notes with you.
Highlights
- AI built into the Studio: a voice reads your posts, AI translates your notes and agents like Claude Code and Codex work on your notes from the terminal. Pay through your Blup Cloud plan, with your own OpenRouter key, or use the voice and the translation on your computer, for free.
- Multilingual sites: each note gets its translation in an
en,esorptfolder next to it, and the site shows a language switcher at the top. - Podcast on blogs: on the Mochi and Nori themes, narrations become episodes with a feed for Spotify and Apple Podcasts.
Where to start
- Never used it? Start with Installation and then Create your first site.
- Want to understand the difference between a site and a vault? See Sites and note vaults.
- Studio or terminal? Read Studio and command line.
- Already opened the Studio? Get to know The Studio window and Writing in the editor.
- Want to take notes without making a site? See What is a vault.
- Going to change the look and the menu? See Site settings.
- Want to use AI? See AI in Blup Studio: post narration, translation, agents in the terminal and how to pay (or not pay) for it.
- Want the site in Portuguese, English and Spanish? See Multilingual sites.
- Have a blog and want a podcast? See Blog podcast.
- Want to understand each part of this site? See Bento sections.
- Ready to publish? See Where to publish.
- Use more than one computer? See Sync your notes.
- Want your notes on the phone? See Blup Notes.
- Like the terminal? See Commands.
What is in each group
| Group | What for |
|---|---|
| Getting started | Install, create your first site and understand the folders |
| Blup Studio | Each part of the app: editor, preview, properties, attachments, trash, settings and terminal |
| Note vaults | Notes just for you: note of the day, map, canvas, drawings and databases |
| Writing | Markdown, properties, links, images, callouts and math |
| Site setup | Name, logo, menu, social links, authors, multilingual sites, cookies and passwords |
| AI features | Post narration, translation, blog podcast and how the AI is paid for |
| Bento sections | Docs, roadmap, changelog, help center, blog and feedback |
| Publishing | Put the site online and use a domain of your own |
| Blup Cloud | Account, plans, encrypted sync and sites on Blup |
| Blup Notes | The app for Android and how to sync it with your computer |
| Command line | blup in the terminal, for people who prefer it |