GitHub - creativefisher/mdreader: Native markdown reader for MacOS · GitHub
/" data-turbo-transient="true" />
Skip to content
Search or jump to...
Search code, repositories, users, issues, pull requests...
-->
Search
Clear
Search syntax tips
Provide feedback
--><br>We read every piece of feedback, and take your input very seriously.
Include my email address so I can be contacted
Cancel
Submit feedback
Saved searches
Use saved searches to filter your results more quickly
-->
Name
Query
To see all available qualifiers, see our documentation.
Cancel
Create saved search
Sign in
/;ref_cta:Sign up;ref_loc:header logged out"}"<br>Sign up
Appearance settings
Resetting focus
You signed in with another tab or window. Reload to refresh your session.<br>You signed out in another tab or window. Reload to refresh your session.<br>You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
{{ message }}
creativefisher
mdreader
Public
Notifications<br>You must be signed in to change notification settings
Fork
Star
main
BranchesTags
Go to file
CodeOpen more actions menu
Folders and files<br>NameNameLast commit message<br>Last commit date<br>Latest commit
History<br>12 Commits<br>12 Commits
Resources
Resources
Samples
Samples
Scripts
Scripts
Sources/MarkdownReader
Sources/MarkdownReader
.gitignore
.gitignore
Makefile
Makefile
Package.resolved
Package.resolved
Package.swift
Package.swift
README.md
README.md
View all files
Repository files navigation
MarkdownReader
MarkdownReader is a small native macOS app for opening and reading local Markdown files with SwiftUI typography and GitHub Flavored Markdown rendering.
Features
Open Markdown files from the File menu or toolbar.
Drag and drop Markdown files onto the window.
Reload the current document with Command-R.
Read tables, task lists, code blocks, blockquotes, links, and images.
Select and copy rendered text.
Works in light and dark mode.
Requirements
macOS 14 or newer
Xcode Command Line Tools or Xcode with Swift 6
Install the command line tools if needed:
xcode-select --install
Run From Source
git clone https://github.com/creativefisher/mdreader.git<br>cd mdreader<br>make run
Install Locally
Build and install the app into your user Applications folder:
make install
Then launch it from Finder, Spotlight, or:
open ~/Applications/MarkdownReader.app
If macOS warns that the app is from an unidentified developer, right-click MarkdownReader.app, choose Open , then confirm.
Build Commands
make build # Compile the debug executable<br>make run # Launch from SwiftPM<br>make package # Create .build/release/MarkdownReader.app<br>make install # Copy the app to ~/Applications<br>make uninstall # Remove the app from ~/Applications<br>make clean # Remove SwiftPM build artifacts
Manual Smoke Test
After installing, open Samples/example.md and check:
File > Open
Toolbar Open
Reload
Drag and drop
Light and dark mode
Tables
Task lists
Code blocks
Blockquotes
Links
Invalid files
Project Layout
Package.swift<br>Resources/Info.plist<br>Samples/example.md<br>Scripts/package-app.sh<br>Sources/MarkdownReader/
Notes
The packaged app is unsigned. Do not commit .build/ or generated .app bundles.
About
Native markdown reader for MacOS
Resources
Readme
Uh oh!
There was an error while loading. Please reload this page.
Activity
Stars
stars
Watchers
watching
Forks
forks
Report repository
Releases
No releases published
Packages
Uh oh!
There was an error while loading. Please reload this page.
Contributors
Uh oh!
There was an error while loading. Please reload this page.
Languages
Swift<br>91.2%
Makefile<br>4.8%
Shell<br>4.0%
You can’t perform that action at this time.