From 823eb3ce477cf3e9a716ec4c3380bbe9c17d8bb5 Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:24:03 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 105 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..47dcc2c --- /dev/null +++ b/README.en.md @@ -0,0 +1,105 @@ +# Edmund +![macOS Version Compatibility](https://img.shields.io/badge/platform-macOS%2014.0%2B-0064e1?style=flat-square&color=0064e1) +![GitHub License](https://img.shields.io/github/license/i7t5/edmund?style=flat-square&color=772678) +![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/i7t5/edmund/total?style=flat-square&color=ff6916) +![Tiny App Icon](docs/assets/AppIcon/AppIcon_16x16.png) + +Edmund is a minimal, file-based, native Markdown editor for macOS with inline live preview. + + +https://github.com/user-attachments/assets/5c9097c7-68d2-4423-b0f5-495979775f6d + +Whether as a companion alongside your Markdown knowledge base or as a standalone editor, +Edmund blends in with macOS and works seamlessly with your files wherever they are. + +Our goal is to be the [CotEditor](https://coteditor.com) of Markdown editors, +i.e. elegant, powerful, configurable, and native inside out. + +> ⚠️ Edmund is currently in beta. See the [roadmap](docs/ROADMAP.md) for what's coming next :D + + +## Differentiators + +- Live preview: Typora/Obsidian-style WYSIWYG. +- File-based: Open `.md` files from anywhere. No vaults or dedicated folders required. +- Native: 100% Swift. Based on AppKit and TextKit 2. No Electron. Minimal dependencies. +- Fast: Handles ~1-2MB files with ease. No launch lag. +- Extensible: Opt-in math and Obsidian syntax. Extensions system coming soon! +- Private: Offline by default. Optional blocking of external links and HTML sanitization. + + + +See [my blog post](https://i7t5.com/posts/2026-06-26-edmund/) for more of the motivation and design philosophy. + + +## Screenshots + +![Basic usage screenshot in light and dark mode](docs/assets/v0.1.0_basic.png) + +![GFM syntax screenshot in edit mode](docs/assets/v0.1.0_gfm-syntax.png) + +![Non-GFM and math syntax screenshot in edit mode](docs/assets/v0.1.0_more-syntax.png) + +![Basic usage in read mode and inspector](docs/assets/v0.1.0_read-mode.png) + + +## Installation + +Get `Edmund.dmg` from the [latest release](https://github.com/I7T5/Edmund/releases/latest), open it, and drag `Edmund.app` to `Applications`: + +Window for drag and drop to install + +> [!WARNING] +> If macOS reports that the app is `🚧DAMAGED🚧` when you're trying to open it for the first time, fear not. +> The app is not damaged. It's just not signed properly because I am not a $99/yr-certified Apple Developer. +> Good thing is there's an easy way to bypass the barrier. +> +> To open Edmund (or any other "damaged" app) for the first time, choose *one* of the following: +> - System Settings → Privacy & Security → scroll down → Open Anyway. Or, +> - Run the following line in Terminal: `xattr -dr com.apple.quarantine /Applications/Edmund.app` +> - You might also need to prepend the command with `sudo`. + +Edmund checks for updates automatically; you can also browse version history [here](https://github.com/I7T5/Edmund/releases). + +## Dependencies + +- [swift-markdown](https://github.com/swiftlang/swift-markdown) +- [SwiftMath](https://github.com/mgriebling/SwiftMath) +- [Sparkle](https://github.com/sparkle-project/Sparkle) + + +## Alternatives + +If Edmund's not your thing, some of the following might be: + +- Closed source + - Obsidian, cyberWriter, Notion + - Typora, Lettera (beta), LitSquare Ink MD +- Open source + - WYSIWYG: [MarkText](https://marktext.me), [Nodes](https://nodes-web.com), [Scratch](https://github.com/erictli/scratch) + - Split-screen: [MacDown](https://macdown.uranusjr.com), [MiaoYan](https://miaoyan.app) + - [MarkEdit](https://github.com/MarkEdit-app/MarkEdit) - TextEdit for Markdown + - I *love* this. If only I wasn't so dependent on rendered math... + - [editxr](https://github.com/pixdeo/editxr) - TUI + - More feature-rich: [FSNotes](https://fsnot.es), [Zettlr](https://www.zettlr.com), [Joplin](https://joplinapp.org), [Tangent](https://www.tangentnotes.com) + +The list is by no means exhaustive, and neither was it meant to be. I just wanted to give credit to the makers of these apps, esp. IMO the aesthetic open sourced ones. A comprehensive list may be found [here](https://github.com/mundimark/awesome-markdown-editors). + + +## Acknowledgements + +The following have greatly influenced the architecture and/or helped with design. I owe them many thanks: + +- [Swift Markdown Engine](https://github.com/nodes-app/swift-markdown-engine) / [Nodes](https://nodes-web.com) for the parser/token architecture and the TextKit 2 integration +- [Typora](https://typora.io) and Apple Notes for app menu organization +- [Tomorrow Light](https://github.com/chriskempson/tomorrow-theme) and [One Dark](https://github.com/atom/atom/tree/master/packages/one-dark-syntax) for code syntax highlighting +- [create-dmg](https://github.com/sindresorhus/create-dmg) for a Apple-looking `.dmg` +- [MarkEdit](https://github.com/MarkEdit-app/MarkEdit) for the readme organization +- [screenshot-studio](screenshot-studio.com) for the amazing screenshots editing experience +- [shields](shields.io) for the beautiful badges in this readme +- Claude, [caveman](https://github.com/JuliusBrussee/caveman), and [ponytail](https://github.com/DietrichGebert/ponytail) for the engineering. + + +## License + +[Apache License 2.0](LICENSE)