Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elipapa/markdown-cv
a simple template to write your CV in a readable markdown file and use CSS to publish/print it.
https://github.com/elipapa/markdown-cv
css curriculum curriculum-vitae cv github-page html jekyll markdown-cv pdf resume resume-template
Last synced: 28 days ago
JSON representation
a simple template to write your CV in a readable markdown file and use CSS to publish/print it.
- Host: GitHub
- URL: https://github.com/elipapa/markdown-cv
- Owner: elipapa
- License: mit
- Created: 2012-10-11T16:18:29.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T09:30:26.000Z (4 months ago)
- Last Synced: 2024-09-29T02:23:00.571Z (about 1 month ago)
- Topics: css, curriculum, curriculum-vitae, cv, github-page, html, jekyll, markdown-cv, pdf, resume, resume-template
- Language: CSS
- Homepage: elipapa.github.io/markdown-cv
- Size: 12.9 MB
- Stars: 1,330
- Watchers: 16
- Forks: 3,255
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - elipapa/markdown-cv - a simple template to write your CV in a readable markdown file and use CSS to publish/print it. (CSS)
- awesome-pdf - cv
- awesome-starred - elipapa/markdown-cv - a simple template to write your CV in a readable markdown file and use CSS to publish/print it. (jekyll)
README
# markdown-cv
A curriculum vitae maintained in plain text and rendered to HTML and PDF using CSS.
For more details, see the [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 markdown-cv repo](https://github.com/elipapa/markdown-cv)
and edit the `index.md` file [directly in Github](https://help.github.com/articles/editing-files-in-your-repository/)
adding your skills, jobs and education.
## Distribution
To transform your plain text CV into a beautiful and shareable HTML page, you have two options:
### I. Use 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](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/#deleting-a-branch).
2. Create a new branch called `gh-pages`.
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.
### II. Build it locally and print a PDF
1. To [install jekyll](https://jekyllrb.com/docs/installation/), run `gem install bundler jekyll` from the command line.
3. [Clone](https://help.github.com/en/articles/cloning-a-repository) your fork of markdown-cv to your local machine.
3. Type `jekyll serve` to render your CV at http://localhost:4000.
4. You can edit the `index.md` file and see the changes live in your browser.
5. To print a PDF, press ⌘ + p. Print and web CSS media queries should take care of the styling.
## 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)).
### License
[MIT License](https://github.com/elipapa/markdown-cv/blob/master/LICENSE)