tvhung83 / markdown-cv

a simple template to write your CV in a readable markdown file and use CSS to publish/print it.

markdown-cv

A curriculum vitae maintained in plain text and rendered to html and pdf using CSS.

For more details see the project page or the blog post on why I switched to markdown for my CV.

---

Usage

To start, simply fork the markdown-cv repo

and then edit directly in github the index.md file

adding your skills, jobs and education.

To transform your plain text CV into a beautiful looking HTML page and share it you then have two options:

Using Github Pages to publish it online

1. Delete the existing gh-pages branch from your fork. It will only contain this webpage. You can either use git or the github web interface
2. Create a new branch called gh-pages (which will then be a copy of master)
3. Head to yourusername.github.io/markdown-cv to see your CV live.

Any change you want to make to your CV from then on would have to be done on the gh-pages branch and will be immediately rendered by Github Pages.

Build it locally and print a PDF

1. install jekyll on your computer. gem install jekyll will do for most users.
2. Clone your fork on your computer
3. Type jekyll serve and you'll be able to see your CV on your local host (the default address is http://localhost:4000).
4. You can edit the index.md file and see changes live in your browser.
5. To print a PDF, just press Print. Print and web CSS media queries should take care of the styling.

is this the only style available?

For the moment, yes. The included CSS renders CV in a style inspired by kjhealy's vita template, but any styling is possible. Contributions and forks are welcome!

Author

Eliseo Papa (Twitter/GitHub/website).

License

MIT License