Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dunqing/resume
Writing Resume with Markdown, Supports deploy to Vercel, Netlify, Cloudflare. 使用 Markdown 编写简历，支持部署到 Vercel、Netlify 和 Cloudflare。
https://github.com/dunqing/resume
markdown remark-markdown resume typescript unified
Last synced: 2 days ago
JSON representation
Writing Resume with Markdown, Supports deploy to Vercel, Netlify, Cloudflare. 使用 Markdown 编写简历，支持部署到 Vercel、Netlify 和 Cloudflare。
- Host: GitHub
- URL: https://github.com/dunqing/resume
- Owner: Dunqing
- License: mit
- Created: 2020-08-03T07:39:54.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-23T21:23:20.000Z (11 days ago)
- Last Synced: 2025-01-26T19:10:26.540Z (8 days ago)
- Topics: markdown, remark-markdown, resume, typescript, unified
- Language: TypeScript
- Homepage: https://resume.todev.cc
- Size: 1.45 MB
- Stars: 366
- Watchers: 3
- Forks: 39
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Introduction
### Purpose
To allow resumes to be previewed anytime, anywhere, written in the Markdown syntax that programmers are most familiar with, and free of charge!
## Supported Features
- [x] Dark mode support
- [x] HTML embedding support
- [x] PDF printing support
- [x] Online preview support
- [x] Custom template support
- [x] Multiple template combination support
- [x] Style override support
- [ ] More personalized templates
## Usage
### [create-resumejs](./packages/create-resumejs/)
Quickly create a resume project, supports deployment on Vercel
1. Create
```shell
pnpm create resumejs
```
2. Choose a template
3. Write your README.md
4. Finish your resume!
## [@resumejs/components](./packages/components/)
Import as components into your own project
### Download
```shell
pnpm add @resumejs/components
```
### 使用
```tsx
import { Resume } from '@resumejs/components'
export default function App() {
const resume = `
# Name
## Personal Information
## Work Information
`
return {resume}
}
```
### Usage Example
- [vite-ant-design-pro](https://github.com/Dunqing/vite-ant-design-pro/tree/main/playground/src/pages/Resume)
## [@resumejs/resume](./packages/resume/)
- CLI support, usage is the same as Vite
- By default, use the README.md in the running directory as your resume markdown
- Supports the vite.config.ts configuration file
> You can directly use create-resumejs to create a project
### Install
```shell
pnpm add @resumejs/resume
```
Dependencies react and react-dom need to be installed.
```shell
pnpm add react react-dom
```
### Development
```shell
resume dev
```
### Build
```shell
resume build
```
### Preview
```shell
resume preview
```
### Custom Templates
```shell
resume dev --template @resumejs/template-nova
resume build --template @resumejs/template-nova
```
[Reference example](./examples/customize-template/)
## Templates
- [@resumejs/template-default](./templates/default/) Default template
- [@resumejs/template-nova](./templates/nova/)
**Default resume template**
## How to customize the template?
### Customize the markdown syntax for writing resumes
1. The content under the first-level title includes the information of the resume header with the first-level title as the header. You can customize the `header` component.
- The first-level title is the name. You can customize the `header-name` component.
- The picture is used as the avatar. You can customize the `header-avatar` component.
- Wrap all list items. You can customize the `header-content` component.
- Each list is a row. You can customize the `header-row` component.
- The item in the list is a column. You can customize the `header-col` component.
2. The first paragraph below the third-level title
- The table will be changed to the description information of the third-level title, and you can customize the `card`, `card-item`, `card-item-label`, `card-item-value` components.
- The first line of text below the title or Table will be changed to the description content, and you can customize the `description` component.
3. FrontMatter (dark mode, Github, print button)
- You can customize the toolbox component.
### Example
- [Default template](templates/default/src/index.tsx)
## Deploy
This is very simple, just click the button above to deploy to Vercel. You can also deploy to other platforms that support Vite.
## Others
This project is tested with [BrowserStack](https://browserstack.com).
[MIT LICENSE](./LICENSE)
