md-preview
Native, local-first Markdown preview and quick editor. Multi-document tabs, session restore, macOS Finder workflow, offline Mermaid/KaTeX. Rust + system WebView, no Electron.
File Explorer
Download Latest Version (.zip)- ci.yml
- release.yml
- preview-enhance.js
- update-check.js
- delphi.min.js
- github-dark.min.css
- github.min.css
- highlight.min.js
- katex.inline.css
- katex.min.js
- mermaid.min.js
- icon.icns
- icon.ico
- icon_1024.png
- app-store-review-demo.md
- hero.jpg
- index.html
- privacy.html
- rust-webview-ai-docs.html
- support.html
- v2ex-md-preview-demo.png
- pre-push
- contents.xcworkspacedata
- project.pbxproj
- Extension.entitlements
- ExtensionInfo.plist
- FinderSyncExtension.swift
- project.yml
- MainActivity.java
- ic_launcher.png
- ic_launcher.png
- ic_launcher.png
- ic_launcher.png
- ic_launcher.png
- strings.xml
- styles.xml
- AndroidManifest.xml
- build.gradle
- build.gradle
- settings.gradle
- Contents.json
- Icon-App-1024x1024@1x.png
- Icon-App-20x20@2x.png
- Icon-App-20x20@3x.png
- Icon-App-29x29@2x.png
- Icon-App-29x29@3x.png
- Icon-App-40x40@2x.png
- Icon-App-40x40@3x.png
- Icon-App-60x60@2x.png
- Icon-App-60x60@3x.png
- Icon-App-76x76@1x.png
- Icon-App-76x76@2x.png
- Icon-App-83.5x83.5@2x.png
- Contents.json
- AppDelegate.swift
- Info.plist
- PreviewViewController.swift
- PrivacyInfo.xcprivacy
- project.yml
- build-release.sh
- generate-android-upload-keystore.sh
- verify-mobile-renderer.mjs
- verify-release-readiness.sh
- delphi.min.js
- github-dark.min.css
- github.min.css
- highlight.min.js
- katex.inline.css
- katex.min.js
- marked.LICENSE.txt
- marked.umd.js
- mermaid.min.js
- preview-enhance.js
- THIRD_PARTY.md
- mobile-preview.css
- mobile-preview.js
- preview.html
- README.md
- RELEASE_CHECKLIST.md
- hero.jpg
- welcome.png
- fetch-sparkle.sh
- generate-app-store-screenshots.mjs
- generate-appcast.sh
- release.sh
- verify-anchor-navigation.mjs
- verify-desktop-reading-tools.mjs
- verify-desktop-search.mjs
- verify-sparkle-update.sh
- verify-windows-self-update.sh
- verify.sh
- main.rs
- session.rs
- .gitattributes
- .gitignore
- AGENTS.md
- build.rs
- bundle.sh
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- gen_ico.py
- gen_icon.py
- install.sh
- LESSONS.md
- LICENSE
- README.md
- README_zh.md
- release-sign.sh
- task.md
# Installation Guide
1. Get the code
git clone https://github.com/vorojar/md-preview
Downloads the entire project code from GitHub to your computer.
cd md-preview
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- APT (Debian/Ubuntu ๊ณ์ด) Built into Debian/Ubuntu-based Linux distributions.
sudo apt-get install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev
Installs directly from the APT package repository (Debian/Ubuntu-based).
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Gradle (Java/Kotlin)
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- JDK (Java) Required to build and run Java/Kotlin projects.
- Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
โ ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd mobile/android/app
This project's files live in a subfolder, so move into it first.
./gradlew build
Builds the project using Gradle.
A BUILD SUCCESSFUL message means it worked. The output is created under build/.
4. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo build
Compiles the Rust project.
cargo test
Type this command into your terminal and run it.
If cargo build finishes without errors, it worked. The executable is created under target/.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)