Skip to content

rozita-hasani/markdown-resume

Repository files navigation

Markdown Resume

Introduction

Markdown Resume is an open-source project that helps users create professional resumes. You write your resume in markdown format, and the editor lets you preview, apply different themes, customize, and export it as a PDF.

Features

  • Write in Markdown: Use simple markdown to write your resume content.
  • Live Preview: See your resume as you type, so you know how it looks.
  • Different Themes: Choose from multiple styles to make your resume unique.
  • Custom Fonts, Layout and Colors: Adjust fonts, sizes, line heights, colors, and more to fit your personal style.
  • Export as PDF: Export your resume as a PDF document that’s ready to share.

Technologies Used

Screenshots

Here are some examples of resumes created with this tool:

Resume Example Resume Example
Resume Example Resume Example

Quick Start

To run the project locally:

1.Install the dependencies:

npm install

2.Run the development server:

npm run dev

5.Open http://localhost:3000 in your browser to see the application.

Contributing

We welcome contributions! To contribute:

  • Fork the repository
  • Create your branch (git checkout -b feature/YourFeature)
  • Commit changes (git commit -am 'Add feature')
  • Push the branch (git push origin feature/YourFeature)
  • Create a Pull Request

License

Licensed under the MIT License.

Contact

For questions or support, please contact [email protected].