# markdown

**Repository Path**: antfl/markdown

## Basic Information

- **Project Name**: markdown
- **Description**: 一个基于 ByteMD 封装的、专为 Vue 3 设计的现代化 Markdown 编辑器组件。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://markdown.byteout.cn
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-06-05
- **Last Updated**: 2025-09-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Markdown, 编辑器

## README

# Vue 3 + ByteMD markdown 编辑器

## 演示地址
https://markdown.byteout.cn

![markdown.png](docs/markdown.png)

中文文档 | [English](./README.en.md)

## 🚀 特性

这是一个 **开箱即用** 的 Vue 3 Markdown 编辑器组件配置示例。基于 `@bytemd/vue` 和其核心插件封装，旨在为你提供一个功能丰富、样式美观的编辑器，**无需复杂配置，直接复制代码即可使用**。

### 已配置功能

- ✅ **核心语法支持**: GitHub Flavored Markdown (GFM)
- ✅ **代码块语法高亮**: 使用 `@bytemd/plugin-highlight` 插件
- ✅ **数学公式支持**: 使用 `@bytemd/plugin-math` 和 KaTeX
- ✅ **流程图 & 时序图等**: 使用 `@bytemd/plugin-mermaid` 插件
- ✅ **中文优化**: 编辑器界面按钮提示已汉化
- ✅ **样式美化**: 引入基础样式及代码高亮主题

## 📦 快速开始

### 1. 安装依赖

将以下依赖添加到你的 `package.json` 并执行 `npm install` 或 `pnpm install`：