Skip to content

在线生成简历工具 | Generate PDF resumes from Markdown with ease.

Notifications You must be signed in to change notification settings

ZY945/ResumeCraft

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown编辑器网站架构设计

项目概述

一个纯前端的Markdown编辑器网站,具有以下功能:

  • 左侧为Markdown输入区域
  • 右侧为实时预览区域
  • 支持导出为PDF功能
  • 界面美观实用
  • 性能快速响应

技术选型

前端框架

使用React作为前端框架,原因如下:

  • 组件化开发,便于维护和扩展
  • 虚拟DOM渲染性能优秀
  • 生态系统丰富,有大量可用的Markdown相关组件
  • 单页应用体验流畅

Markdown解析与渲染

使用marked库进行Markdown解析,配合highlight.js实现代码高亮。

PDF导出功能

使用html2pdf.js库实现将渲染后的Markdown内容导出为PDF文件。

UI组件库

使用Chakra UI组件库来快速构建美观的界面。

构建工具

使用Vite作为构建工具,相比Webpack提供更快的开发体验和构建速度。

项目结构

markdown-editor/
├── public/
│   ├── index.html
│   └── favicon.ico
├── src/
│   ├── components/
│   │   ├── Editor.jsx        # Markdown输入组件
│   │   ├── Preview.jsx       # Markdown预览组件
│   │   ├── Header.jsx        # 顶部导航栏
│   ├── utils/
│   │   └── pdfGenerator.js   # PDF生成工具
│   ├── App.jsx               # 应用主组件
│   └── main.jsx              # 入口文件
├── package.json
├── vite.config.js
└── README.md

功能流程

  1. 用户在左侧编辑区输入Markdown文本
  2. 应用实时解析Markdown并在右侧预览区显示渲染结果
  3. 用户可以随时点击"导出PDF"按钮,将当前预览内容导出为PDF文件
  4. 可选功能:支持主题切换、自动保存到LocalStorage等

性能优化考虑

  • 使用防抖(debounce)技术处理Markdown实时渲染,避免频繁更新导致性能问题
  • 考虑使用Web Worker进行Markdown解析,避免阻塞主线程
  • 使用React.memo或useMemo优化组件重渲染
  • 按需加载第三方库,减小打包体积

部署方案

由于是纯前端项目,可以部署在以下平台:

  • GitHub Pages(免费)
  • 任何支持静态网站的托管服务

About

在线生成简历工具 | Generate PDF resumes from Markdown with ease.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published