Docs

First steps

A ten-minute tour: create notes, link them, add tags and tasks, find things with search and get to know the editor modes.

On this page
  1. The window
  2. Create a note
  3. Edit, Split, Preview
  4. Link two notes
  5. Tag a note
  6. Tasks
  7. Find something
  8. Rename and delete
  9. Quit

This page walks through the main things you do in Blocknotik. It assumes the program is installed and open in your browser.

The window

At the top: the search box, the New note button and the Menu (import, export, language, quit). On the left: the list of notes, newest first, and below it the tags. On the right: the open note — its title, the editor and the preview, and at the bottom the list of notes that link here.

With an empty notes folder you see a short welcome text and two buttons. Create sample notes adds three small notes that link to each other; they're a quick way to see links, tags, a table and tasks. Delete them whenever you like.

Create a note

Click New note or press Alt+N (on a Mac, Option+N). A note called “Untitled” appears and its title is selected: type a real title and press Enter. The cursor moves to the text.

The title is the file name. If you type Plans for March, the file is Plans for March.md. Characters that are not allowed in file names on some systems — / \ : * ? " < > | and also # [ ] — are replaced by a dash.

Now write. Blocknotik saves on its own a moment after you stop typing; the status next to the mode buttons says Saved. Ctrl+S saves immediately if you want to be sure.

Edit, Split, Preview

The three buttons above the text switch between:

  • Edit — only the text, full width. Good for writing.
  • Split — text on the left, formatted preview on the right. The preview updates as you type.
  • Preview — only the formatted note. Good for reading; links are clickable.

Ctrl+E cycles through the modes. The choice is remembered in your browser.

Type the title of another note in double square brackets:

Starter feeding is in [[Sourdough log]].

In the preview this becomes a link. Clicking it opens the other note, and at the bottom of that note Linked from now lists the note you came from.

If the note doesn't exist yet, the link is red. Click it and Blocknotik creates the note with that title, ready for writing. This is a comfortable way to grow notes: write first, link to things that deserve their own page, fill them in later.

More forms of links — with your own text, to a heading, to a note in a subfolder — are on the syntax page.

Tag a note

Write # and a word anywhere in the text: #kitchen, #to-read, #work/reports. Tags show up in the sidebar with the number of notes. Clicking one shows all notes with that tag.

Tasks

Lines starting with - [ ] are open tasks, - [x] done ones:

- [ ] call the plumber
- [x] buy flour

In the preview they appear as checkboxes, done tasks struck through. To tick a task, change the space to x in the text — the checkboxes in the preview are not clickable in this version.

Find something

Click into the search box or press Ctrl+K and type. The list on the left narrows with every letter and shows an excerpt with the matches highlighted. Enter opens the first result, Esc clears the search. See Search for phrases, exclusions and tags.

Rename and delete

To rename, click the title, change it and press Enter (or click elsewhere). Links to the note in other notes are updated; a short message tells you how many notes were changed. Esc in the title field cancels.

Delete (top right) asks for confirmation and moves the file into the .trash folder inside your notes folder. Nothing is erased; to bring a note back, move the file out of .trash with your file manager.

Quit

Choose Menu → Quit Blocknotik, or close the program window, or press Ctrl+C in it. Unsaved text is saved first when you quit from the menu. Closing only the browser tab leaves the program running; open the address again to continue.