elipapa / 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.

---

Customization

Simply fork the markdown-cv repo

and edit the index.md file directly in Github

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.
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, run gem install bundler jekyll from the command line.
2. Clone 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.
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/Github/Website).

License

MIT License

markdown-cv's Issues

<i></i> and <b></b> tags don't work

Hi there,

I'm trying to use jekyll-scholar to automate the bibliography section and I found out that when generated, the HTML tags <i></i> and <b></b> are there but are never displayed in the screen. I tested in both Firefox and Chrome in case it was an issue with the browser but the result is the same.

This also happens if I write literal HTML tags in the index.md, they appear in the source code of the HTML but they are not rendered in the screen.

Any idea why this could be?

Thank you in advance,
Xabi

PS: this is the link to the jekyll-scholar issue inukshuk/jekyll-scholar#242

Bullet points when printing?

Any idea why when I print to save as a PDF the bullet points disappear? It's really annoying and I can't figure out how to fix it!

https://anthonypiccolo.xyz/markdown-cv/

Missing HTML Entity

After 'My wikipedia page' include '<'. Otherwise the CV will not render when using Jekyll. I would fix this myself in a clone repository and then merge it back with yours, but I'm not quite there yet. I'll 'git' on that soon. Thanks!

Pandoc Method

Observing

• https://github.com/sdsawtelle/markdown-resume
• https://github.com/mszep/pandoc_resume
• https://github.com/vasylenko/serhii.vasylenko.info
• https://github.com/mikepqr/resume.md
• https://github.com/mauserrifle/resume
• https://github.com/pineapplegiant/resume

Would a PanDoc based solution be better suited?

Changes do not update to GitHub pages when pushing to the gh-pages branch

I've just pushed a commit to the gh-pages branch (here it is), however my CV on my GitHub page hasn't been updated.

Do I need to merge to master too?

[Feature request] Make CSS responsive for mobile view

Great idea and implementation, design looks very good on desktop and PDF.

Just on mobile, it could really be better. It's not really usable there, only with much pinching and zooming in out, even then, not the whole line is readable.

Since 2012, when this seems to have been started, mobile has become much more important. Maybe some of the forks contain tweaks to make it responsive, if not, would be great if someone could touch it up.

This is how it looks on my OnePlus 6T with Opera:

Manual

Thanks for this great tool! I'm a bit lost, however, and wanting of greater clarity in instruction. Could you please update the Readme file? Many thanks!

converter from markdown to json

jsonresume made an effort to standardize this in the open. However markdown is a far better input language.

a markdown to resume.json converter would allow to

1. input using markdown
2. leverage the themes https://jsonresume.org/themes/

add more CSS stylesheets options

the readme should show what the markdown maps to in terms of CSS/html styles

it's not clear and it could be made visual, at least for the default style

Sidebar titles misaligned

When printing, the sidebar is misaligned with the main content.

HTML

Printable PDF

Notice the headings - Currently and Education that have shifted up by a few pixels.

Sections that start with a list out of alignment; adding empty date fixes it

Out of alignment example:

Markdown:

## Currently
- Assistant Professor
- Organizational Leadership and Information Analytics
- Leeds School of Business
- University of Colorado Boulder

Brought back (mostly) in-alignment with empty date example:

Markdown:

## Currently
` `
- Assistant Professor
- Organizational Leadership and Information Analytics
- Leeds School of Business
- University of Colorado Boulder

Adding a h2+ul rule also seems to fix it, whether or not an empty date is added:

h2+ul {
    margin-top: 2px;
}