Chukke documentation

Editing and Preview

Work with Markdown source, rendered preview, formatting tools, and document structure.

Plain Markdown remains the source of truth throughout the editing workflow. Formatting actions edit Markdown syntax directly.

Chukke opens, creates, and saves regular UTF-8 .md, .markdown, and .txt documents up to 10 MiB. Larger documents are left unchanged on disk and must be reduced with another tool before Chukke can open or save them.

Choose a view

  • Edit gives the source editor the available document space.
  • Split places source and rendered preview together.
  • Preview focuses on the rendered document.

For a very long or line-heavy document, Chukke pauses rendered Preview before it can make the window unresponsive. The document stays open and unchanged. Use Edit document to view and edit its Markdown source, or close its tab. Documents above the 10 MiB open limit are rejected with an error message inside Chukke.

Open documents stay in tabs with dirty indicators for unsaved changes.

Format Markdown

The macOS Format menu and Command Palette provide the complete Markdown command catalog. You can switch between paragraph text and H1–H6, apply inline formatting and links, create quotes and lists, insert code blocks, images, tables, and horizontal rules, or remove selected inline formatting. Table inserts an editable Markdown template directly into the source.

Use Format > Insert > Image from File… for a local image in a workspace document. An image already inside the workspace is validated and referenced where it is. An image selected outside the workspace is copied, never moved, into the one root folder named assets case-insensitively. Chukke preserves an existing folder’s capitalization, such as Assets/, or creates lowercase assets/ when none exists. Existing files are never overwritten: identical bytes reuse the current asset, while a different collision receives a numbered filename. Markdown stores an encoded path relative to the current document. If no text is selected, Chukke derives readable alt text from the filename. The caret is left after the complete image reference without selecting the generated text.

Preview loads local and embedded images in small batches. If a document contains too many or too-large images for one Preview render, additional images show an “Image preview paused” message. The Markdown and existing images remain unchanged, and you can continue editing the document.

You can also drop one supported image from Finder anywhere over the source editor. The Markdown stays visible during the drag, with the current editing caret showing where Chukke will insert the reference. The mouse location only confirms that the drop is inside the editor. After release, Chukke reports whether it referenced the workspace file or copied an external raster into the asset folder. Drops outside the editor, folders, browser URL drags, unsupported files, and multi-file batches make no change. External SVG files must be reviewed and placed in the workspace manually before they can be referenced.

Use Format > Insert > Image from URL… in a workspace or individually opened document. Both the HTTPS URL and alt text are required. Chukke rejects credentials, fragments, IP addresses, localhost-like hosts, and custom ports, and does not fetch the image during insertion. Preview keeps its existing explicit Load remote image consent for every image and render.

Use Format > Insert > Attachment from File… for a PDF, DOCX, XLSX, PPTX, TXT, CSV, or JSON file in a workspace document. A valid file already inside the workspace is referenced where it is. An external file is copied, never moved, into the one root folder named attachments case-insensitively. Chukke preserves an existing folder’s capitalization, such as Attachments/, or creates lowercase attachments/ when none exists. Assets/ remains separate. Existing files are never overwritten: identical bytes reuse the current attachment, while a different collision receives a numbered filename. Selected text becomes the link label; otherwise Chukke derives a readable label from the filename. The caret is left after the complete link without selecting the label.

You can also drop one supported attachment from Finder anywhere over the source editor. The Markdown stays visible during the drag, with the current editing caret showing where Chukke will insert the link. The mouse location only confirms that the drop is inside the editor. After release, Chukke reports whether it referenced the workspace file or copied an external file into the attachment folder. Drops outside the editor, browser URL drags, symbolic links, folders, unsupported files, and multi-file batches make no change. Attachments are checked for bounded format identity before insertion, including PDF framing, UTF-8 text, valid JSON, and non-macro OOXML structure. Validation is not malware scanning, so Preview reveals PDF, Office, CSV, and JSON attachments in Finder without rendering or opening them. Open a revealed attachment only if you trust it. Use the ordinary Link command for remote files; Chukke does not download remote attachments.

Normal Paste also recognizes one supported file copied from Finder while the source editor is focused. It uses the same image or attachment validation, destination, reuse, numbering, and no-overwrite rules as the picker and Finder drop. A screenshot or image copied from Preview or a browser is decoded within the image limits and saved as a new metadata-free PNG named pasted-image.png in the root asset folder. If that name is occupied, identical generated bytes are reused or a numbered name is chosen. Selected editor text becomes the alt text or link label; otherwise Chukke inserts a readable default. In every case, the caret is left after the complete Markdown reference rather than selecting its label.

Clipboard access happens only in response to that explicit editor paste. Chukke does not monitor the clipboard, retain clipboard permission, expose source paths, or materialize raw attachments. Ordinary text, Markdown, copied URLs, HTML-only content, and plain filesystem paths keep the editor’s normal paste behavior and never authorize file access or remote downloading. Pasting files in Preview, a dialog, or outside the source editor does not import anything, and local file paste requires a workspace document.

Imported files and auto-created asset or attachment directories are normal user-owned workspace content. Undo removes only the Markdown reference. Chukke History does not copy the binary, and preference reset, cleanup, reinstall, and automatic pruning never delete imported content. If a file is later moved or deleted in Finder or Git, Chukke does not rewrite existing Markdown automatically.

Selecting an HTTP or HTTPS link in Preview opens it in your default browser while Chukke keeps the document open. Links to .md, .markdown, and .txt files inside the active workspace open in Chukke, including heading fragments. Approved attachment links reveal the contained file in Finder without launching it. Relative links from an individually opened external document remain unavailable because that file does not authorize access to its containing folder. Absolute paths, workspace escapes, symbolic links, and unsupported URL schemes never navigate the app WebView.

The persistent document toolbar provides the original headings, bold, italic, inline code, quotes, bullet and numbered lists, and links. Strikethrough, Task List, and Code Block are also available as optional toolbar actions. The contextual selection toolbar intentionally retains its original compact set. Selection-aware actions preserve the selected text while applying Markdown syntax.

To personalize the persistent document toolbar, use the checked Format > Customize Formatting submenu, choose Customize Formatting… from the Command Palette, or secondary-click the toolbar and open its formatting customization. Select an action to show it and clear it to hide it. Changes apply immediately, while action order stays fixed. The original ten actions are visible by default; Strikethrough, Task List, and Code Block begin hidden. When you enter from Customize Toolbar, choose Back to Customize Toolbar to return to the group list. Hiding a toolbar button never removes its command from the Format menu or Command Palette.

Formatting customization is a local Chukke preference. It does not change the Markdown document or write configuration into the workspace. Reset Formatting restores only the formatting action set, while Reset Toolbar also restores the toolbar groups.

Use Format > Insert > Internal Note to place an internal NOTE around selected text or at the cursor. The document toolbar and Command Palette provide the same action. Model-ready can identify and clean these deterministic note ranges when you prepare the document.

Preview features

The local preview supports:

  • interactive task lists that update the matching Markdown marker and leave the document unsaved until you save it
  • stable heading anchors for contents lists and cross-document links
  • contained horizontal scrolling for wide tables
  • syntax-highlighted code blocks
  • workspace-relative PNG, JPEG, GIF, and WebP images up to 10 MiB, 8192 pixels per side, and 40 megapixels
  • inert workspace-relative and bounded data SVG images up to 2 MiB, with active and external features removed
  • individually approved HTTPS raster and SVG images, loaded only after you select Load remote image
  • dollar- or bracket-delimited inline ($...$ or \(...\)) and display ($$...$$ or \[...\]) LaTeX as local static MathML
  • labelled footnotes using [^label] references and indented [^label]: definitions
  • GitHub, Obsidian, and Material callouts, including native collapsible disclosures
  • a sanitized subset of semantic raw HTML, including details, tables, ruby annotations, progress, and meter
  • Mermaid diagrams in mermaid fences, with a local error state when one diagram is invalid
  • heading-based outline navigation

Bounded base64 raster data: images use the same signature and dimension checks before rendering. SVG is sanitized and displayed through an inert image boundary; scripts, links, animation, embedded media, external references, entities, oversized documents, and excessive nesting are rejected. Remote images are never fetched automatically. Each Load remote image action authorizes only that image for the current render, sends no credentials or referrer, and does not create a saved permission. HTTP images, audio, video, and other remote media remain blocked. Mermaid is loaded only when the current preview contains a Mermaid diagram, and one invalid diagram does not prevent other diagrams from rendering. A preview renders at most 64 Mermaid diagrams; later diagrams show a paused message so the app stays responsive. The Markdown source remains available in Edit or Split view.

Math is rendered locally without a runtime script, font download, stylesheet, CDN, or network request. Dollar and bracket delimiters share the same safety limits. Invalid, unsafe, or over-limit expressions show a local syntax message while later expressions continue rendering. Each render is limited to 500 expressions and 256 KiB of TeX input, with limits of 4 KiB per inline expression and 64 KiB per display expression.

Footnote references scroll to a labelled Footnotes section and backlinks return to the exact reference, including repeated references. Definitions can contain multiple paragraphs, formatting, and code blocks.

Callouts use an explicit type allowlist. The standard types are NOTE, TIP, IMPORTANT, WARNING, and CAUTION; Chukke also recognizes INFO, SUCCESS, QUESTION, FAILURE, DANGER, BUG, EXAMPLE, and QUOTE. Blockquote markers such as > [!NOTE] remain static. Add + to open an Obsidian disclosure or - to start it collapsed. Material !!! type "Title" callouts are static, while ??? type "Title" starts collapsed and ???+ type "Title" starts open; indent the Material body by four spaces. Callouts accept normal nested Markdown. Unknown, malformed, and escaped markers remain ordinary blockquotes.

Raw HTML passes through a strict allowlist sanitizer before it reaches any rendered surface. Semantic text, safe tables, details/summary, ruby annotations, progress, meter, and a bounded presentation-only inline-style subset are supported. Scripts, forms, raw controls, event handlers, resource-loading CSS, iframes, objects, embeds, canvas, audio, video, and author-controlled internal IDs or attributes are removed or replaced with a local blocked-media message.

These features behave the same in document Preview, bundled Help and template previews, and standalone HTML export where applicable. Standalone export uses system fonts and a restrictive content-security policy, makes no remote requests, keeps relative image references relative, and does not read workspace assets. Remote and SVG content is emitted only through inert local representations or placeholders.

External changes and save conflicts

Chukke watches the workspace for changes. If the file on disk changed after you opened it, Chukke surfaces a save conflict so you can review the difference rather than silently overwriting the external version. When the combined comparison exceeds 512 KiB, either document exceeds 2,000 lines, or the line-count product exceeds 2,000,000, Chukke skips line-by-line highlighting and changed-line totals but keeps both complete documents available side by side.

Find and navigate

Use editor find for source text and Preview Find for rendered content. The Outline panel moves between document headings without changing the file’s Markdown structure.

For region cycling, arrow-key behavior, document switching, context menus, and the complete fixed-shortcut reference, see Keyboard Shortcuts.