# markdown-editor

**Repository Path**: WDFM/markdown-editor

## Basic Information

- **Project Name**: markdown-editor
- **Description**: 这是一个electron+vue开发的markdown编辑器
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-03-13
- **Last Updated**: 2023-03-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown Editor

This is a simple Markdown editor built with Vue.js and Electron. It allows you to create and edit Markdown files and preview the rendered output in real-time.

## Installation

To install and run the application locally, follow these steps:

1. Clone the repository to your local machine.
2. Install dependencies.
```bash
# use npm
npm install

#use yarn
yarn
```
3. Start the development server.
```bash
# use npm
npm run dev

#use yarn
yarn dev
```
4. Build the application for distribution:
```bash
# use npm
npm run build

#use yarn
yarn build

# build for Windows
# use npm
npm run build-windows

#use yarn
yarn build-windows
```

## Download
You can download apps from [HERE](https://gitee.com/WDFM/markdown-editor/releases).

## Usage

Once you have the application installed, you can start using it to create and edit Markdown files. The preview pane will automatically update as you make changes to the file.

You can also use the application to open existing Markdown files on your computer.

## Contributing

If you find any issues or would like to contribute to the project, feel free to open an issue or submit a pull request on GitHub.

## License

This project is licensed under the [**MIT** License](https://gitee.com/WDFM/markdown-editor/blob/master/LICENSE).