me

Create a resume by writing a .yml file.

Installation

1. Fork this repository

2. Clone it

   git clone https://github.com/$username/me.git
   cd me

3. Using Yarn to install dependencies

   yarn install

Usage

1. Replace my information with yours in data/en.yml and data/zh-TW.yml

2. Each $name.yml file will create a $name version of resume. In my case, it will be zh-TW and en.

   Feel free to add a .yml file in this folder to create a new version of resume.

   

3. Preview your resume in http://localhost:1234

   yarn start

Download PDF

1. Click Print Mode button (at the bottom right)

   

2. Right click the browser and print it

   

3. Save it as a .pdf file.

   

Deployment

Deploy to your Github Pages

yarn deploy

http://$username.github.io/me

Build With

• Vue - JavaScript framework
• Bootstrap - Front-End component library
• Font Awesome - Icons
• Day.js - Date library
• Parcel - Pack and bundle modules
• gh-pages - publishing files to gh-pages branch

Contributing

Bug reports and pull requests are welcome on GitHub at repository.

For major changes, please open an issue first to discuss what you would like to change.

Code of Conduct

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

You can read CHANGELOG.md for more details.

Authors

• 楊竑昕 mailto:jk195417@gmail.com

See also the list of contributors who participated in this project.

License

This project is available as open source under the terms of the MIT License.

You can read LICENSE.md for more details.