|
1 | | -# markdown-cv |
| 1 | +Front page to showcase [markdown-cv](http://elipapa.github.io/markdown-cv/) functionality. |
2 | 2 |
|
3 | | -A curriculum vitae maintained in plain text and rendered to HTML and PDF using CSS. |
4 | | - |
5 | | -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). |
6 | | - |
7 | | -*** |
8 | | - |
9 | | -## Customization |
10 | | - |
11 | | -Simply [fork the markdown-cv repo](https://github.com/elipapa/markdown-cv) |
12 | | - |
13 | | - |
14 | | - |
15 | | -and edit the `index.md` file [directly in Github](https://help.github.com/articles/editing-files-in-your-repository/) |
16 | | - |
17 | | - |
18 | | - |
19 | | -adding your skills, jobs and education. |
20 | | - |
21 | | - |
22 | | - |
23 | | -## Distribution |
24 | | - |
25 | | -To transform your plain text CV into a beautiful and shareable HTML page, you have two options: |
26 | | - |
27 | | -### I. Use Github Pages to publish it online |
28 | | - |
29 | | -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). |
30 | | -2. Create a new branch called `gh-pages`. |
31 | | -3. Head to *yourusername*.github.io/markdown-cv to see your CV live. |
32 | | - |
33 | | -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. |
34 | | - |
35 | | -### II. Build it locally and print a PDF |
36 | | - |
37 | | -1. To [install jekyll](https://jekyllrb.com/docs/installation/), run `gem install bundler jekyll` from the command line. |
38 | | -3. [Clone](https://help.github.com/en/articles/cloning-a-repository) your fork of markdown-cv to your local machine. |
39 | | -3. Type `jekyll serve` to render your CV at http://localhost:4000. |
40 | | -4. You can edit the `index.md` file and see the changes live in your browser. |
41 | | -5. To print a PDF, press <kbd>⌘</kbd> + <kbd>p</kbd>. Print and web CSS media queries should take care of the styling. |
42 | | - |
43 | | -## Styling |
44 | | - |
45 | | -The included CSS will render your CV in two styles: |
46 | | -s |
47 | | -1. `kjhealy` the original default, inspired by [kjhealy's vita |
48 | | -template](https://github.com/kjhealy/kjh-vita). |
49 | | -2. `davewhipp` is a tweaked version of `kjhealy`, with bigger fonts and dates |
50 | | - right aligned. |
51 | | - |
52 | | -To change the default style, simply change the variable in the |
53 | | -`_config.yml` file. |
54 | | - |
55 | | -Any other styling is possible. More CSS style contributions and forks are welcome! |
56 | | - |
57 | | -### Author |
58 | | - |
59 | | -Eliseo Papa ([Twitter](http://twitter.com/elipapa)/[Github](http://github.com/elipapa)/[Website](https://elipapa.github.io)). |
60 | | - |
61 | | - |
62 | | - |
63 | | -### License |
64 | | - |
65 | | -[MIT License](https://github.com/elipapa/markdown-cv/blob/master/LICENSE) |
| 3 | +The theme for this page is [Solo](http://chibicode.github.io/solo) |
0 commit comments