# md-reader

**Repository Path**: wgwangjiang/md-reader

## Basic Information

- **Project Name**: md-reader
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-15
- **Last Updated**: 2026-05-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# md-reader

A lightweight Markdown editor built with Tauri, offering multiple view modes including editing, preview, and split-screen, with full support for Markdown and GFM syntax rendering.

## Features

### Editing Functions
- **Multi-mode View**: Seamlessly switch between editing mode, preview mode, and split-screen mode
- **New File**: Ctrl+N to quickly create a new file
- **Save File**: Ctrl+S to save, with support for "Save As"
- **Undo/Redo**: Full history tracking functionality
- **Find and Replace**: Powerful search and batch replacement capabilities

### Formatting Tools
- **Heading Styles**: 1-6 level headings with dropdown menu for quick selection
- **List Formats**: Ordered and unordered lists
- **Links and Images**: Insert links and images
- **Tables**: Quickly insert Markdown tables
- **Horizontal Rule**: Insert horizontal separators

### Export Functions
- **PDF Export**: Export to PDF files
- **Web Page Export**: Export to HTML web pages

### Other Features
- **Link Navigation**: Click links to open them in the default browser
- **Font Settings**: Customize editor font and size
- **Window Title**: Displays the name of the currently edited file
- **File Association**: Supports .md file association (Windows)
- **Double-click to Open**: Directly open .md files with a double-click

## Technology Stack

- **Frontend**: HTML + JavaScript + CSS
- **Backend**: Rust (Tauri)
- **Build Tool**: Vite

## Quick Start

### Prerequisites

- Node.js 18+
- Rust 1.70+
- Modern browser (required for development mode)

### Install Dependencies

```bash
npm install
```

### Development Mode

```bash
npm run dev
```

### Build Desktop Application

```bash
npm run tauri build
```

## Keyboard Shortcuts

| Shortcut | Function |
|----------|----------|
| Ctrl+N   | New File |
| Ctrl+S   | Save File |
| Ctrl+O   | Open File |
| Ctrl+Z   | Undo |
| Ctrl+Y   | Redo |
| Ctrl+F   | Find |
| Ctrl+H   | Replace |

## Project Structure

```
md-reader/
├── src/                    # Frontend source code
│   ├── index.html        # Main page
│   ├── main.js          # Main logic
│   └── styles.css      # Stylesheet
├── src-tauri/            # Tauri backend
│   ├── src/
│   │   ├── commands.rs # Command implementations
│   │   ├── lib.rs     # Library definitions
│   │   └── main.rs   # Entry point
│   └── tauri.conf.json # Tauri configuration
└── package.json        # Project configuration
```

## License

MIT License