Files

T

chore: vendor swift-markdown-engine as plain tracked source

Convert from git submodule to plain vendored copy. No push access to
upstream nodes-app/swift-markdown-engine meant our local fix commit
(05c1720) was stranded and unreachable from any remote on fresh
clones/CI. Vendoring as plain files folds it into normal repo history
instead.

2026-08-20 13:26:13 +01:00

2.6 KiB

Raw Blame History

`MarkdownEngine`

A TextKit 2-backed Markdown editor view for macOS, bridged to SwiftUI.

Overview

MarkdownEngine provides a native AppKit Markdown editor with live styling, wiki-style [[Name]] linking, fenced code blocks with syntax highlighting, LaTeX rendering, embedded images, and GitHub-style task checkboxes.

The engine itself has zero external dependencies. Everything app-specific is injected through small service protocols, so embedders stay in control of where wiki-links resolve, where embedded images live, how code is highlighted, and how LaTeX is rendered.

Quick Start

import SwiftUI
import MarkdownEngine

struct EditorScreen: View {
    @State private var text: String = "# Hello, *world*"
    @State private var isLinkActive: Bool = false
    @State private var pendingReplacement: InlineReplacementRequest?

    var body: some View {
        NativeTextViewWrapper(
            text: $text,
            isWikiLinkActive: $isLinkActive,
            pendingInlineReplacement: $pendingReplacement,
            configuration: .default,
            fontName: "SF Pro",
            documentId: "doc-1"
        )
    }
}

The default MarkdownEditorConfiguration ships with no-op service implementations, so the editor renders plain Markdown out of the box. Add real services as you need them.

Customizing Appearance

var theme = MarkdownEditorTheme.default
theme.bodyText = .labelColor
theme.headingMarker = .secondaryLabelColor

var configuration = MarkdownEditorConfiguration.default
configuration.theme = theme

Wiring Up Services

let services = MarkdownEditorServices(
    wikiLinks: MyWikiLinkResolver(),
    images:    MyImageProvider(),
    syntaxHighlighter: MySyntaxHighlighter(),
    latex:     MyLatexRenderer()
)

var configuration = MarkdownEditorConfiguration.default
configuration.services = services

Topics

Editor View

NativeTextViewWrapper

Configuration

MarkdownEditorConfiguration
MarkdownEditorTheme

Service Protocols

WikiLinkResolver
EmbeddedImageProvider
SyntaxHighlighter
LatexRenderer

Services Container

MarkdownEditorServices
MarkdownEditorBus

Default No-Op Implementations

NoOpWikiLinkResolver
NoOpEmbeddedImageProvider
PlainTextSyntaxHighlighter
NoOpLatexRenderer

Selection & Replacement

InlineSelectionState
InlineSelectionKind
WikiLinkSelection
InlineReplacementRequest
CodeBlockSelection

Wiki-Link Roundtripping

WikiLinkService

Pasteboard Helpers

PasteboardImageReader

2.6 KiB Raw Blame History

MarkdownEngine