Skip to content

izmaze/MarkdownViewer

 
 

Repository files navigation

Markdown Viewer

A simple standalone markdown viewer-only app for Windows 11.

Built with TauriRust + SvelteKit + TypeScript.

Using GitHub flavored markdown style by sindresorhus and rendered with comrak.

Note

Changes in v2.1.0

  • Integrated custom installer into main executable
  • Added .md file association on installation
  • Added syntax highlighting
  • Added LaTeX formatting

Changes in v2.0.0

  • Fixed relative image embeds
  • Added YouTube embed support
  • Added shortcut to edit in Notepad
  • Added recent files on startup
  • Added 'watch' mode to watch the markdown file for changes and update the markdown file in real-time

Usage

  • Download the latest installer from the releases page
  • Right click on a markdown file and select "Open with" and select the downloaded or installed executable
  • [Optional] Set the executable as the default program to open .md files

Alternatively, you can install from source:

  • Clone the repository
  • Run npm install to install dependencies
  • Run npm run tauri build to build the installer
  • Repeat the steps above to set the executable as the default program to open .md files

Screenshots

alt text alt text alt text alt text

Todo

  • Fix relative image embeds
  • Add shortcut to edit in default text editor
  • Tweak Windows installer to prevent desktop shortcut by default
  • Add syntax highlighting for code blocks
  • Add file association option for .md files in the Windows installer
  • Add option to toggle markdown rendering
  • Add tabs

About

A simple standalone markdown viewer-only app for Windows 10/11 built with Tauri + SvelteKit

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Svelte 58.7%
  • CSS 28.8%
  • Rust 7.8%
  • JavaScript 2.9%
  • HTML 0.7%
  • TypeScript 0.6%
  • NSIS 0.5%