Merkzeug

Choose your edition: Mac & Linux, iPhone & iPad, or IntelliJ IDEA.

Mac & Linux · iPhone & iPad · IntelliJ IDEA

Merkzeug – Mac & Linux Help

The interface and this help use German on a German system and English otherwise. You can switch the help language independently.

Merkzeug is a Notion-style editor for Markdown notes – this edition runs on macOS and Linux (Windows is coming soon). You edit your notes WYSIWYG (formatted, without visible Markdown syntax), but everything is always saved as clean, portable Markdown. All notes live as .md files in an ordinary folder – the vault.

Shortcuts below show Mac first, followed by Linux/Windows. The shortcut table lists each platform explicitly.

Contents: 1. Getting started · 2. Sidebar & file tree · 3. Tabs, sections & windows · 4. Editor & formatting · 5. Links · 6. Navigation mode · 7. Mermaid diagrams · 8. Image assets · 9. PDF export · 10. Git integration · 11. Keyboard shortcuts · Meeting notes and calendars · Linux installation & differences


1. Getting started

2. Sidebar & file tree

The sidebar on the left shows the vault as a hierarchical tree.

3. Tabs, sections & windows

4. Editor & formatting

The editor shows the note formatted; what is saved is Markdown.

Selecting a whole table cell highlights the cell; click inside its text to place the caret and edit. Text and links retain their colors while the cell is selected, including when using PDF-template styles.

6. Navigation mode (reading & browsing)

For browsing linked notes there is a per-tab navigation mode – toggled with ⌘R / Ctrl+R, via View → Navigation Mode or the book icon in the toolbar.

7. Mermaid diagrams

8. Image assets

9. PDF export

Templates give the PDF a company layout: a logo and header on every page, a footer with page numbers, and an optional cover page.

10. Git integration

Merkzeug uses a separately installed Git executable for desktop version control. On macOS, Git is available through Apple’s Command Line Tools or a separate Git installation; full Xcode is not required. If Git is missing or cannot start, the sidebar shows Git is unavailable. Choose Git setup for installation instructions, then Check again after installing or configuring Git. Automatic Git checks pause while it is unavailable. Merkzeug does not launch Apple’s developer-tools installation dialog. Editing notes and exporting PDFs continue to work without Git.

If the vault is a Git repository, a status line appears at the bottom of the sidebar:

11. Keyboard shortcuts

Function Mac Linux / Windows
New note ⌘N Ctrl+N
New meeting note ⌃⌘N Ctrl+Alt+Shift+N
New folder ⇧⌘N Ctrl+Shift+N
New window ⌥⌘N Ctrl+Alt+N
Open vault ⌘O Ctrl+O
Close tab / Close window ⌘W / ⇧⌘W Ctrl+W / Ctrl+Shift+W
Save / Save all ⌘S / ⌥⌘S Ctrl+S / Ctrl+Alt+S
Print ⌘P Ctrl+P
Settings (PDF templates) ⌘, Ctrl+,
Bold / Italic / Strikethrough / Inline code ⌘B / ⌘I / ⌥⌘X / ⌘E Ctrl+B / Ctrl+I / Ctrl+Alt+X / Ctrl+E
Text / Heading 1–6 ⌥⌘0 … ⌥⌘6 Ctrl+Alt+0 … Ctrl+Alt+6
Bullet list / Numbered list ⌥⌘8 / ⌥⌘7 Ctrl+Alt+8 / Ctrl+Alt+7
Quote / Code block ⇧⌘B / ⌥⌘C Ctrl+Shift+B / Ctrl+Alt+C
Insert link ⌘K Ctrl+K
Insert table ⌥⌘T Ctrl+Alt+T
Find / Find and replace ⌘F / ⌥⌘F Ctrl+F / Ctrl+Alt+F
Toggle navigation mode ⌘R Ctrl+R
Back / Forward ⌘[ / ⌘] Ctrl+[ / Ctrl+]
Toggle second section ⌘\ Ctrl+\
Move tab to other section ⇧⌘\ Ctrl+Shift+\
Show/hide assets ⇧⌘R Ctrl+Shift+R
This help ⌘? F1

(Windows/Linux: ⌘ = Ctrl, ⌥ = Alt, ⇧ = Shift)

Shared editor and save conflicts

Desktop, iOS and IntelliJ use the same Merkzeug editor. Frontmatter is preserved and can be opened in the editor. Failed saves leave changes marked as unsaved. When external changes conflict with your edits, reload the external version or explicitly keep your own version.

Mac App Store folder access

The Mac App Store edition remembers access when you select a vault or PDF-template folder. If macOS revokes access or the folder moves, select it again.

Support and feedback

Use Help → Contact Support… to open the support form with Merkzeug, your language, edition and app version selected. You can deselect the app details before sending. No note contents or file paths are attached automatically.

Contact Merkzeug App Support. Include your app version, operating system and steps to reproduce the issue. Use fictional examples and avoid confidential notes.

PDF template starter

Merkzeug ships a ready-to-use Merkzeug PDF template: a warm paper cover, serif headings, blue accents, page headers and numbered footers. In Settings → Template for this vault, select Merkzeug. Existing vaults keep their current selection, including No template. Create makes an editable copy under a new name; Edit opens its folder. Your changes are never overwritten by an app update. Changing the templates root makes the starter available there too, if the folder is writable.

Remove or rename deckblatt.html to omit the cover. Customize stil.css for document styles and kopfzeile.html / fusszeile.html for inline header/footer styles. Margins are in vorlage.json. Keep the German filenames and {{titel}} / {{datum}} placeholders; they are the shared template format. Put logo images in the template folder and reference them using relative paths. The template works in IntelliJ too: PDF template… opens the bundled starter folder initially when no other template is selected. iPhone and iPad also use templates for editor styling, PDF-file export and AirPrint.

Adapt a template with an agent

Create a copy first, then give the agent that folder and this prompt:

Read README.md and all five template files in this folder. Adapt this copy to my visual style: [COLORS], [FONTS] and [LOCAL LOGO PATH]. Preserve the filenames, title/date placeholders and Chromium page-number spans. Keep header/footer CSS inline and document CSS scoped to PDF selectors. Use local assets, no scripts or network dependencies. Support A4 portrait and landscape without clipping. Update README.md to explain the changes. Validate by exporting notes with a long title, headings, links, code, a table and a diagram; inspect every page of the resulting PDFs.

The template README includes the full file-format reference and a reusable prompt. Export through Merkzeug to check the result: browser previews alone do not verify page breaks. The settings link Template guide and agent prompt opens this section of the online manual; the same instructions are also included in the app's offline help.

Appearance, tours and agent guidance

Choose System, Light or Dark for appearance. System follows the operating system (the IDE in IntelliJ); your choice is saved. The Guided tour starts only after you accept the first-use invitation and can be reopened at any time. Its Read and navigate step explains the read/edit switch and link navigation. Open a note before starting the tour to see its mode button highlighted.

When opening a vault, Merkzeug can suggest root AGENTS.md / CLAUDE.md instructions for Note.md and Note.assets/. Review the single proposed text and the full contents of both instruction files. Select the destination files explicitly before choosing Add; none is preselected. For example, leave CLAUDE.md unchanged when it only redirects to AGENTS.md. Missing files are created only when selected. Later postpones it for the current session; Do not suggest again for this vault suppresses future prompts for that vault. Contradictory or unclear attachment rules require manual review. Concurrent external changes are preserved and require a refreshed preview. Existing shared assets/ references remain readable.

Calendar sources

New meeting note offers calendar selection. Expand Calendar sources to import an .ics file or add a named private HTTPS/Webcal subscription. Subscriptions are saved on this device, never in the vault. Refresh calendars downloads changes; an error retains the previous snapshot and shows its saved time. Reimporting the same named ICS file updates its source without duplicating notes. Choose a term to create or reopen its meeting note; existing note text is never replaced. CalDAV and calendar write-back are not supported.

In Settings, select the PDF template for this vault. Enable Use PDF template while editing in the bottom bar to preview its document typography and colors. Disable it to return to the editor theme. Only .pdf-content content rules are reused; cover pages, page furniture, print layout and application-wide CSS are excluded. This is a formatting preview, not a paginated PDF proof. PDF export keeps the complete original template and print colors. Linux needs a system keyring for private subscriptions; ICS files can be imported without one.

Mermaid diagrams use the document background instead of a dark code-block panel and switch to the light PDF theme when PDF template editing styles are active, and return to the application theme when the preview is disabled.

Template styling prompt

Desktop Settings provides Template styling prompt for each template; expand it to review and copy a complete agent brief with the template's folder path. IntelliJ offers the same action in Settings → Tools → Merkzeug, using the folder currently shown in the settings field. On iOS, open Help → Template styling prompt and substitute the folder path on the agent's computer; iOS supports PDF template styles while editing, PDF export, and printing through AirPrint.

Replace the new template name and your colors, fonts, logo and design wishes before sending it. The prompt is in English, includes the complete offline technical reference, and works with older templates that lack instruction files. Copying it does not read note contents or modify existing templates. If clipboard access is unavailable in the web view, select and copy the displayed text manually.

New starter copies include AGENTS.md (format, CSS examples, placeholders, preview limitations and validation) and STYLING-PROMPT.md (reusable brief). Keep template-specific design choices in README.md. The brief instructs the agent to create a separate copy and preserve existing instructions. Existing desktop templates are not upgraded or overwritten. For manual use, concatenate STYLING-PROMPT.md and AGENTS.md and replace the template-path placeholder.

License

Merkzeug is licensed under the MIT License. The full license text is included at the end of the in-app help and is also available on the website. Third-party components retain their own licenses.

Printing

Choose File → Print… (⌘P on macOS, Ctrl+P on Windows/Linux). Merkzeug saves pending edits, prepares the same PDF used for export, and opens the system print dialog. The PDF preview stays available after printing or cancellation. It includes the selected template, cover, headers, footers, diagrams and images. Linked documents can optionally be included. No PDF destination needs to be chosen; the temporary PDF is removed when its preview closes. PDF export remains a separate menu action.

Shared iCloud templates

On macOS, Merkzeug uses iCloud Drive → Merkzeug → Templates when iCloud Drive is available. On first use, templates from the old default folder are copied and verified before the configured folder changes. Originals stay in the old folder as a recovery copy. An explicitly chosen custom folder is retained.

In Settings, Use Merkzeug iCloud templates copies your current templates to the shared folder and switches after verification. Different files with the same name stop migration without overwriting either version; review them before retrying.

On Windows with iCloud Drive, this action becomes available after the public Merkzeug folder has synchronized. Open Merkzeug on an Apple device first. Custom iCloud Drive locations registered with Windows are supported, as are the usual user-profile locations. Use Change… to select a synchronized templates folder directly if discovery is unavailable. Linux can use any mounted synchronized folder through Change….

All devices must use the same iCloud account. Allow synchronization to finish before editing templates on another device. iOS uses the same folder and vault assignment.

Meeting-note filenames

A meeting note uses its first heading as the filename. Case, spaces and accents are preserved; characters forbidden in cross-platform filenames are replaced, and a suffix resolves collisions without replacing another note or image folder. After saving a changed heading, Merkzeug renames the note and its companion .assets/ folder. Calendar identity stays in frontmatter: choosing the same event again reopens its existing note in the selected folder, including notes created with the older meeting-… names. Those older names update when you edit and save the heading. Keep the calendar identity fields to preserve this association.

Renaming a note or folder through Merkzeug updates local Markdown links to it in other Markdown files in the same vault. This also applies when a saved heading automatically changes a note's filename. Companion .assets/ folders and links to their images follow the note. Moving a note also recalculates its outgoing relative links; shared image folders stay in place.

Inline links, images and reference-style link definitions are supported, including URL-encoded names and #section suffixes. Link labels and titles stay unchanged. Section suffixes are preserved, not recalculated when a heading changes. Code examples, frontmatter, external URLs and ordinary prose are not rewritten. HTML links and wiki-link syntax are not included.

Only regular Markdown files inside the vault are considered; hidden/ignored folders and symbolic links are not followed. Renames outside Merkzeug are not detected as refactoring. Destination collisions or stale file contents stop the operation. Open documents reload when clean; unsaved conflicting edits are preserved for review rather than silently overwritten.

When you quit Merkzeug, all open vault windows are restored on the next launch, including their size, position and fullscreen/maximized state. Windows closed individually before quitting stay closed. Missing vault folders are skipped; windows from disconnected displays are moved onto an available display.

Sharing templates in a repository

A template is an ordinary folder containing vorlage.json, stil.css, and its HTML fragments and assets. You can keep that folder in a Git repository so your team can review changes and use the same layout. Commit the complete folder, including logos and fonts that you are allowed to share.

In the PDF controls, choose Template inside this vault and enter the template's relative folder. The assignment in .merkzeug/settings.json works across desktop, iPhone/iPad and IntelliJ. Commit and pull that file together with the template folder using your normal Git workflow.

Alternatively, store central templates in iCloud Drive → Merkzeug → Templates and choose Central template. iCloud sharing between your own Apple devices requires the same account and completed synchronization.

PDF-file export and combining directly linked documents are available on desktop, iPhone/iPad, and in IntelliJ. The selected template also applies when printing.

Choose a template location

In the PDF controls above an open note (IntelliJ: …), choose PDF template for this vault. Select Central template, choose a name and press Apply, or select Template inside this vault, enter its relative folder (for example .merkzeug/templates/Company) and press Apply. The choice applies to every note in this vault, including editing styles, PDF export and printing. It does not move or copy template files. Choose No template and Apply to clear the assignment.

The portable assignment is stored in .merkzeug/settings.json. A central template is referenced by name; a vault template uses {"pdfTemplate":{"source":"vault","path":".merkzeug/templates/Company"}}. Commit the settings and template folder to share them with a repository. Existing central assignments remain compatible. On Apple devices, the central collection uses Merkzeug's iCloud container when available; a locally selected template collection remains a device setting. IntelliJ also discovers installed desktop templates. Missing template folders are reported instead of silently substituting another template.

Release Notes

Open Release Notes in Help (IntelliJ: …) for the complete English or German version history, available offline. On the first start of a new marketing version, its release notes open automatically. Done marks that version as read on this installation; the full history remains accessible. Website and apps use the same release-note source.

Linux installation and platform differences

Choose a separate package for your Linux architecture: x86_64 (x64) for Intel/AMD PCs, or ARM64 (aarch64) for ARM computers, including Linux on Apple Silicon in Parallels. Run uname -m if unsure. The packages contain only their selected architecture. In the commands below, replace x64 with arm64 for ARM64.

Download updates manually from the Merkzeug website. Verify downloads against the published SHA-256 checksums. These checksums detect changed files; they are not publisher certificates. Your notes and configuration remain outside the application package.

The shared desktop editor includes visual editing, Mermaid, reading/navigation mode, frontmatter, title-based filenames, companion image folders and link updates on move/rename, PDF templates, combined PDF export, printing and agent prompts. Install Git separately for the built-in Git operations; configure authentication through your normal Git tools.

Linux meeting notes use ICS files or HTTPS/Webcal calendar subscriptions. There is no direct GNOME/KDE system-calendar connector. A system keyring is required for storing private subscription URLs; local ICS import works without one. Linux uses a local central templates folder by default, or a folder you select. Vault templates in .merkzeug/ travel with a repository; mounted sync folders also work. Automatic Apple iCloud discovery is unavailable. Printing depends on the system's configured printers and drivers.

Meeting notes and calendars

Meeting notes from the calendar: ⌃⌘N / Ctrl+Alt+Shift+N (menu "File → New Meeting Note…" or the calendar button in the footer) lists the running and upcoming events of the next 14 days from your locally configured calendars — on macOS all accounts of the Calendar app (iCloud, Exchange/Microsoft 365, Google, …), on Windows all calendars of classic Outlook (via its object model; the "new Outlook" has none), with no cloud API involved. All-day events (vacations, birthdays, …) are hidden by default and can be shown via the checkbox above the list. "Show earlier events" reveals past events, "Search" searches titles, people and locations within ±90 days. Clicking an event creates a ready-named note: the event data (date, time, location, organizer, attendees, detected Teams/Zoom/Meet/Webex link) goes into the frontmatter; the body contains date and time below the heading, a checkable attendee list (who actually showed up?) and the Agenda, Notes and Tasks sections. The first time, macOS asks for permission to access the calendar. On Windows, Outlook is started in the background if needed; if Outlook shows a security prompt ("A program is trying to access …"), allow access for a few minutes. On Linux and with new Outlook, use Calendar sources to import ICS files or subscribe to HTTPS/Webcal feeds.

Open File → New Meeting Note…, or use the calendar button below the file tree. On Mac, allow Calendar access when requested; configured Apple Calendar accounts supply events. On Linux, open Calendar sources to import an .ics file or add an HTTPS/Webcal subscription URL. Refresh to load current events; imported files are snapshots, subscriptions can be refreshed. Private subscription URLs are stored using the system keyring. Never commit private feed URLs to Git.

Choose an event to create a Markdown meeting note in the selected folder. Edit the agenda, record minutes and mark attendees and tasks as the meeting progresses. The note follows its first heading when renamed automatically; manual filenames are preserved. Your calendar event is never modified.

If the list is empty, check the date, all-day filter, calendar permissions on Mac and configured sources on Linux. Linux has no direct GNOME/KDE calendar connection. Windows/classic Outlook support belongs to the forthcoming Windows edition.

About Merkzeug

Merkzeug is open source under the MIT License. The About Merkzeug view shows the version, publisher and product website. On desktop, use the Merkzeug menu; on iPhone/iPad, open Help; in IntelliJ, open the editor’s … menu.