Git Product home page Git Product logo

markdownviewer's Introduction

Markdown Viewer

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

Built with Tauri โ€” Rust + SvelteKit + TypeScript.

Using GitHub flavored markdown style by sindresorhus and rendered with comrak. Using window-vibrancy to add Mica effect to the window.

Usage

  • Download the latest .exe executable or .msi 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 .exe executable and .msi bundle
  • Repeat the steps above to set the executable as the default program to open .md files

Screenshots

screenshot of this readme screenshot of this readme in lightmode

Known Issues

  • Not tested in Windows 10 and earlier, meaning the window background may not look as intended
  • Relative image embeds don't work
  • YouTube/video embeds don't work

Todo

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

markdownviewer's People

Contributors

alecames avatar

Stargazers

Matthew Fulford avatar Razvan B. avatar Azeez Abass avatar Ibrahim avatar Alex avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.