You are reading the docs of the unreleased development version. Go to the latest version →
Skip to content

Configuration ​

Blank reads its settings from blank.json in the app config folder. The file is optional: list only what you want to change, everything else keeps its default.

The settings (Mod ,) write this file for you and apply each change at once. They keep only what differs from the defaults, and leave the rest of the file, including settings they don't show, as you wrote it.

SystemConfig file
Linux~/.config/com.github.fpurchess.blank/blank.json
Snap~/snap/blank/current/.config/com.github.fpurchess.blank/blank.json
macOS~/Library/Application Support/com.github.fpurchess.blank/blank.json
Windows%APPDATA%\com.github.fpurchess.blank\blank.json

Restart Blank after changing the file by hand. If the file is not valid JSON, Blank ignores it and uses the defaults. A single setting that Blank can't use, such as "false" in quotes instead of false, or a shortcut for a command it doesn't know, never stops Blank from starting: it keeps the default for that setting and tells you which ones it ignored. Other names it doesn't know are skipped.

Keyboard shortcuts ​

Map a command to a key under keymap. Keys are written like Mod-Shift-s, where Mod is Cmd on macOS and Ctrl elsewhere. This example saves with Ctrl Alt S and exports the PDF with Mod P:

json
{
  "keymap": {
    "file.save": "Ctrl-Alt-s",
    "export.pdf": "Mod-p"
  }
}

The tab commands are named tab.…, e.g. "tab.close": "Mod-w". Ctrl Page Up and Ctrl Page Down always go to the previous and next tab too, unless you give those keys to another command here; the settings don't allow that.

An empty key, "", takes a command's key away. A code block has none to start with: give it one here if you make code blocks often, e.g. "blocktype.code_block": "Mod-Alt-0".

You can also write the modifiers the way your keyboard names them: Option works like Alt, and Command, Cmd and Super work like Meta. Case doesn't matter, so option-p is fine too.

The default configuration, with every command and its key
json
{
  "keymap": {
    "undo": "Mod-z",
    "redo": "Mod-Shift-z",
    "blocktype.paragraph": "Mod-0",
    "blocktype.heading1": "Mod-1",
    "blocktype.heading2": "Mod-2",
    "blocktype.heading3": "Mod-3",
    "blocktype.heading4": "Mod-4",
    "blocktype.heading5": "Mod-5",
    "blocktype.heading6": "Mod-6",
    "blocktype.bullet_list": "Mod-8",
    "blocktype.ordered_list": "Mod-9",
    "blocktype.code_block": "",
    "insert.horizontal_rule": "Mod-h",
    "insert.image": "Mod-Alt-i",
    "insert.table": "Mod-t",
    "insert.page_break": "Mod-Enter",
    "insert.block": "Mod-Alt-b",
    "block.settings": "Shift-Enter",
    "insert.signature": "",
    "format.indent": "Tab",
    "format.unindent": "Shift-Tab",
    "format.bold": "Mod-b",
    "format.italic": "Mod-i",
    "format.underline": "Mod-u",
    "format.code": "Mod-e",
    "format.link": "Mod-Alt-k",
    "format.blockquote": "Mod-g",
    "format.align_left": "Mod-Shift-l",
    "format.align_center": "Mod-Shift-e",
    "format.align_right": "Mod-Shift-r",
    "format.align_justify": "Mod-Shift-j",
    "file.new": "Mod-n",
    "file.save": "Mod-s",
    "file.save_as": "Mod-Shift-s",
    "file.open": "Mod-o",
    "file.print": "Mod-p",
    "tab.close": "Mod-w",
    "tab.next": "Ctrl-Tab",
    "tab.previous": "Ctrl-Shift-Tab",
    "tab.reopen": "Mod-Shift-t",
    "tab.move_left": "Ctrl-Shift-PageUp",
    "tab.move_right": "Ctrl-Shift-PageDown",
    "export.pdf": "Mod-Alt-p",
    "export.docx": "Mod-Alt-w",
    "export.signed_pdf": "Mod-Alt-Shift-p",
    "signing.signature": "",
    "signing.initials": "",
    "theme.cycle": "Mod-Alt-t",
    "language.choose": "Mod-Alt-l",
    "spellcheck.toggle": "Mod-Alt-s",
    "spellcheck.next": "Mod-Alt-n",
    "spellcheck.previous": "Mod-Alt-Shift-n",
    "menu.context": "Shift-F10",
    "page.setup": "Mod-Alt-u",
    "edit.header": "Mod-Alt-h",
    "edit.footer": "Mod-Alt-f",
    "view.pages": "Mod-Alt-v",
    "view.outline": "Mod-Alt-o",
    "view.signatures": "",
    "view.focus_next": "F6",
    "view.focus_previous": "Shift-F6",
    "view.toolbar_focus": "Alt-F10",
    "view.focus": "Mod-Shift-f",
    "tools.stats": "Mod-Alt-c",
    "app.settings": "Mod-,",
    "view.blocks": "",
    "app.shortcuts": "",
    "app.guide": "",
    "app.about": "",
    "file.clear_recent": "",
    "view.zoom_in": "Mod-=",
    "view.zoom_out": "Mod--",
    "view.zoom_fit": "",
    "menu.main": "Mod-k",
    "edit.find": "Mod-f",
    "pdf.sign": "",
    "pdf.next": ""
  },
  "autocorrect": {
    "arrows": true,
    "dashes": true,
    "symbols": true,
    "formatting": true,
    "links": true,
    "quotes": true,
    "capitalize": true,
    "blocks": true,
    "replace": {
      "*": {}
    }
  },
  "spellcheck": {
    "ignoreUppercase": true,
    "ignoreWordsWithNumbers": true
  },
  "editor": {
    "indentSize": 4
  },
  "focusMode": {
    "hideAfter": 3
  },
  "layout": {
    "page": {
      "size": "auto",
      "orientation": "portrait",
      "margins": "2.5cm"
    }
  },
  "signing": {
    "name": "",
    "dateFormat": "long",
    "timestampServer": ""
  }
}

Autocorrect ​

Each group can be turned off with false. replace adds your own replacements, either for all languages (*) or for one:

json
{
  "autocorrect": {
    "capitalize": false,
    "replace": {
      "*": { "btw": "by the way" },
      "de": { "mfg": "Mit freundlichen Grüßen" }
    }
  }
}

The groups are arrows, dashes, symbols, formatting, links, quotes, capitalize and blocks. All are on by default. A replacement for a language also applies to its regional variants: one for de works in de-CH too.

Spell check ​

Spell check leaves words in capitals and words with digits alone. Set these to false to check them as well:

json
{
  "spellcheck": {
    "ignoreUppercase": false,
    "ignoreWordsWithNumbers": false
  }
}

The words you add to the dictionary are kept next to blank.json, in the dictionaries folder.

Code blocks ​

Tab and Shift Tab indent and outdent the lines of a code block by 4 spaces. Set another indent size, from 1 to 16 spaces, with indentSize; it's also how wide a tab counts there:

json
{
  "editor": {
    "indentSize": 2
  }
}

Focus mode ​

In focus mode, the bars fade when you type, and also once the mouse has rested for hideAfter seconds, 3 by default. 0 fades them only when you type; up to 60 seconds work:

json
{
  "focusMode": {
    "hideAfter": 10
  }
}

Signing ​

signing is what signing puts under your signature. Settings ▸ Signing writes it for you:

  • name: your name, for signature blocks that don't name who signs.
  • timestampServer: the web address of a timestamp server (RFC 3161), which proves when you signed a PDF with your certificate, e.g. http://timestamp.digicert.com. Empty, the PDF has your computer's time. Blank sends the server only a fingerprint of your signature, never the document.
  • dateFormat: how the date is written in the document's language, "long" (8 October 2026, the default), "short" (08.10.2026 in German, 10/08/2026 in American English) or "iso" (2026-10-08).
json
{
  "signing": {
    "name": "Ada Lovelace",
    "dateFormat": "short"
  }
}

Your signature and initials themselves aren't in blank.json: they're images in the signing folder next to it.

Forms ​

Your own forms are form definitions, YAML files in the forms folder next to blank.json. See Your own forms for what they say.

Page setup ​

layout.page is the page setup of documents that don't have their own. Make this my default in the page setup writes it for you:

json
{
  "layout": {
    "page": {
      "size": "a5",
      "orientation": "landscape",
      "margins": "2cm"
    }
  }
}

It takes the same settings as the properties of a file. The default size is auto, the paper of your region. Headers and footers belong to each document, so Make this my default leaves them out. To number the pages of every document, add them here yourself, e.g. "footer": { "center": "{page}" }.