Skip to content

PiBOH/multimdreader

Repository files navigation

icon

Download the latest release here

Version 0.0.6_STABLE · Author: PiBOH

🔤 A cross-platform Markdown file reader. No installation required — just download and run.

Build Web Release Windows Release macOS Release Linux Deploy Pages

🌐 Read this in: 🇮🇹 Italiano · 🇬🇧 English (UK) · 🇺🇸 English (US) · 🇪🇸 Español · 🇩🇪 Deutsch · 🇫🇷 Français

✨ Features

  • 📖 Read Markdown files with beautiful, GitHub-style rendering
  • 🎨 Syntax highlighting for code blocks (100+ languages)
  • 🌐 6 languages supported: 🇮🇹 Italiano, 🇬🇧 English (UK), 🇺🇸 English (US), 🇪🇸 Español, 🇩🇪 Deutsch, 🇫🇷 Français (note: translations other than Italian may not be 100% accurate)
  • 🌙 Dark / Light mode with system preference detection
  • 📂 Recent files sidebar with persistent history
  • 🖱️ Drag & drop support for opening files
  • 📋 GFM support: Tables, task lists, strikethrough, autolinks
  • 🖥️ Cross-platform: Windows, macOS, Linux (Debian, Arch, and more)
  • No installation required: Download and run
  • 📋 Copy code button on code blocks

📥 Downloads

Download the latest release from the Releases page.

Platform File How to run
Windows MultiMDReader_*_x64-setup.exe Double-click to install & run
Windows (Portable) multimdreader.exe Just run the .exe — no install needed
macOS (Intel) MultiMDReader_*_x64.dmg Open .dmg → drag to Applications
macOS (Apple Silicon) MultiMDReader_*_aarch64.dmg Open .dmg → drag to Applications
Linux (Debian/Ubuntu) MultiMDReader_*_amd64.deb sudo dpkg -i *.deb
Linux (All distros) MultiMDReader_*_amd64.AppImage chmod +x && ./MultiMDReader_*.AppImage
Linux (Arch) multimdreader-*.pkg.tar.zst sudo pacman -U *.pkg.tar.zst

⚠️ Testing notice: Only Windows releases have been tested by the author. macOS and Linux builds are provided as-is and may contain platform-specific issues. If you encounter a problem on macOS or Linux, please open an issue.

🌐 Try Online

🚀 Building from Source

Prerequisites

Web Build (Browser)

npm install
npm run build
# Output in dist/

Desktop Build (Tauri)

# Install Tauri CLI (included in devDependencies)
npm install

# Development
npm run tauri dev

# Production build
npm run tauri build
# Output in src-tauri/target/release/bundle/

Generating Icons

npx tauri icon public/icon.png

🏗️ CI/CD Workflows

Build Workflow (.github/workflows/build.yml)

Runs on every push/PR to main — builds the web app to verify it compiles.

Release Workflows (per-OS)

Each workflow runs on tag push (v*) — builds desktop apps for the specific platform:

Workflow Platform Output
release-windows.yml Windows .exe installer + portable .exe
release-macos.yml macOS Intel + Apple Silicon .dmg for both architectures
release-linux.yml Linux .deb, .AppImage, Arch .pkg.tar.zst

Deploy Pages Workflow (.github/workflows/deploy-pages.yml)

Runs on every push to main — deploys both the dashboard and demo to GitHub Pages:

  • / → Project dashboard/landing page
  • /demo/ → Live web app demo

🛠️ Tech Stack

  • Frontend: React 19, TypeScript, Tailwind CSS 4
  • Markdown: react-markdown, remark-gfm, rehype-highlight
  • i18n: i18next, react-i18next
  • Desktop: Tauri v2 (Rust)
  • Build: Vite, GitHub Actions

📄 Supported File Formats

.md, .markdown, .mdown, .mkd, .mkdn, .mdwn, .mdtxt, .mdtext, .txt

⌨️ Keyboard Shortcuts

Shortcut Action
Ctrl+O Open file
Ctrl+B Toggle sidebar
Ctrl+D Toggle dark/light
Escape Close dialog

📝 License

MIT © PiBOH


Repository: github.com/PiBOH/multimdreader
Author: PiBOH
Version: 0.0.6_STABLE