Skip to content

MrXujiang/md-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

✨ md-editor - 一款开箱即用的md编辑器

让创作回归纯粹,同时拥有专业级力量
一款专为开发者和文字工作者设计的开源Markdown编辑器,融合极简界面与强大功能。

🌐 跨平台同步

  • 云端存档:自动保存至 GitHub Gist/Dropbox
  • PWA 支持:无需安装,浏览器即用

🛠️ 快速开始

安装方式

# npm
npm install

# yarn
yarn

# pnpm
pnpm install

或直接下载:最新发行版

基础使用

  1. 创建新文档 Cmd/Ctrl + N
  2. 输入 # 标题 开始创作
  3. Cmd/Ctrl + P 切换预览模式
  4. 支持一键导出为Markdown

🧑💻 开发者指南

技术栈

  • 核心框架: React + Typescript
  • 编辑器引擎: ByteMd
  • 样式系统: Less + CSS Module

本地构建

git clone git@github.com:MrXujiang/md-editor.git
cd md-editor
npm install
npm run dev

🤝 加入创新者行列

我们欢迎各种形式的贡献:

📜 开源协议

本项目采用 MIT License 授权

更多优质项目

项目名称 应用场景
H5-Dooring 可视化零代码搭建
flowmix/docx 下一代多模态文档编辑器
橙子轻文档 文档项目管理平台

About

An out - of - the - box Markdown editor

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors