https://github.com/zachpeterson13/peterson-resume

https://github.com/zachpeterson13/peterson-resume

Last synced: 29 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/zachpeterson13/peterson-resume
• Owner: zachpeterson13
• License: mit
• Created: 2021-12-04T20:38:24.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-12-11T22:52:35.000Z (about 3 years ago)
• Last Synced: 2024-03-16T18:09:04.015Z (10 months ago)
• Homepage: https://zachtpeterson.com/PETERSON-Resume/
• Size: 135 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# md-resume

A resume maintained in plain text and rendered to HTML and PDF using CSS.

For more details, see the [markdown-csv project page](http://elipapa.github.io/markdown-cv), or the blog post on [why I switched to markdown for my CV](http://elipapa.github.io/blog/why-i-switched-to-markdown-for-my-cv.html).

***

## Customization

Simply [fork the mdresume repo](https://github.com/byuids-resumes/mdresume)

![](https://help.github.com/assets/images/help/repository/fork_button.jpg)

and edit the `index.md` file in the `docs` folder [directly in Github](https://help.github.com/articles/editing-files-in-your-repository/)

![](https://help.github.com/assets/images/help/repository/edit-file-edit-button.png)

adding your skills, jobs and education.

![](https://help.github.com/assets/images/help/repository/edit-readme-light.png)

## Distribution

To transform your plain text resume into a beautiful and shareable HTML page, you have two options:

### I. Use Github Pages to publish it online

1. Edit or move your resume to the `index.md` file in the `docs` folder.

2. Go to settings > GitHub pages to make the changes shown.

![](docs_setup.png)

3. Head to *yourusername*.github.io/mdresume to see your resume live.

Any change you want to make to your CV from then on would have to be done in the `docs` folder and will be immediately rendered by Github Pages.

## Styling

The included CSS will render your CV in two styles:

s

1. `kjhealy` the original default, inspired by [kjhealy's vita

template](https://github.com/kjhealy/kjh-vita).

2. `davewhipp` is a tweaked version of `kjhealy`, with bigger fonts and dates

  right aligned.

To change the default style, simply change the variable in the

`_config.yml` file.

Any other styling is possible. More CSS style contributions and forks are welcome!

### Author

Eliseo Papa ([Twitter](http://twitter.com/elipapa)/[Github](http://github.com/elipapa)/[Website](https://elipapa.github.io)).

![Eliseo Papa](https://s.gravatar.com/avatar/eae1f0c01afda2bed9ce9cb88f6873f6?s=100)

### License

[MIT License](https://github.com/elipapa/markdown-cv/blob/master/LICENSE)