https://github.com/kuyoonjo/md-viewer

https://github.com/kuyoonjo/md-viewer

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/kuyoonjo/md-viewer
• Owner: kuyoonjo
• Created: 2024-06-25T15:40:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-20T18:10:54.000Z (about 1 year ago)
• Last Synced: 2024-12-25T23:07:52.552Z (11 months ago)
• Language: SCSS
• Size: 1.43 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

• awesome-tauri - MD Viewer - Cross-platform markdown viewer. (Applications / Office & Writing)

README

          






MD Viewer - a simple markdown viewer app




[![Windows Support](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)](https://github.com/kuyoonjo/md-viewer/releases) [![Ubuntu Support](https://img.shields.io/badge/Ubuntu-E95420?style=for-the-badge&logo=ubuntu&logoColor=white)](https://github.com/kuyoonjo/md-viewer/releases) [![Mac Support](https://img.shields.io/badge/MACOS-adb8c5?style=for-the-badge&logo=macos&logoColor=white)](https://github.com/kuyoonjo/md-viewer/releases)





[![License MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)

[![GitHub package.json version](https://img.shields.io/github/package-json/v/kuyoonjo/md-viewer?color=%40&label=latest)](https://github.com/kuyoonjo/md-viewer/releases/latest)

![GitHub issues](https://img.shields.io/github/issues-raw/kuyoonjo/md-viewer)





![GitHub all releases](https://img.shields.io/github/downloads/kuyoonjo/md-viewer/total)



## Screenshot

![](./screenshot.png)

## Installation

Download the installer for your operating system [on the release page](https://github.com/kuyoonjo/md-viewer/releases).

## Run Locally

Clone the project

```bash

  git clone https://github.com/kuyoonjo/md-viewer.git

```

Go to the project directory

```bash

  cd md-viewer

```

Install dependencies

```bash

  pnpm install

```

Note : Follow [this guide](https://tauri.studio/en/docs/getting-started/intro/#setting-up-your-environment) to set up Tauri environment

Start the server

```bash

  pnpm tauri dev

```