Skip to content

Commit 5c39feb

Browse files
authored
Merge pull request elipapa#21 from zpeterson/update-jekyll-cmd
README cleanup including updated command for installing jekyll
2 parents 545335e + 421d1f4 commit 5c39feb

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

README.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,62 @@
1-
markdown-cv
2-
===========
1+
# markdown-cv
32

4-
A curriculum vitae maintained in plain text and rendered to html and pdf using CSS.
3+
A curriculum vitae maintained in plain text and rendered to HTML and PDF using CSS.
54

6-
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).
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).
76

87
***
98

10-
## Usage
9+
## Customization
1110

12-
To start, simply [fork the markdown-cv repo](https://github.com/elipapa/markdown-cv)
11+
Simply [fork the markdown-cv repo](https://github.com/elipapa/markdown-cv)
1312

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

16-
and then [edit directly in github](https://help.github.com/articles/editing-files-in-your-repository/) the `index.md` file
15+
and edit the `index.md` file [directly in Github](https://help.github.com/articles/editing-files-in-your-repository/)
1716

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

2019
adding your skills, jobs and education.
2120

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

24-
To transform your plain text CV into a beautiful looking HTML page and share it you then have two options:
23+
## Distribution
2524

26-
## 1) Using Github Pages to publish it online
25+
To transform your plain text CV into a beautiful and shareable HTML page, you have two options:
2726

28-
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)
29-
2. Create a new branch called `gh-pages` (which will then be a copy of master)
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`.
3031
3. Head to *yourusername*.github.io/markdown-cv to see your CV live.
3132

3233
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.
3334

35+
### II. Build it locally and print a PDF
3436

35-
## 2) Build it locally and print a PDF
36-
1. [install jekyll](https://jekyllrb.com/docs/installation/) on your computer. `gem install jekyll` will do for most users.
37-
2. Clone your fork on your computer
38-
3. Type `jekyll serve` and you'll be able to see your CV on your local host (the default address is http://localhost:4000).
39-
4. You can edit the `index.md` file and see changes live in your browser.
40-
5. To print a PDF, just press *Print*. Print and web CSS media queries should take care of the styling.
41-
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.
4242

43-
### Change the style
43+
## Styling
4444

45-
The included CSS renders CV in different styles:
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.
4651

47-
- `kjhealy` the original default, inspired by [kjhealy's vita
48-
template](https://github.com/kjhealy/kjh-vita)
49-
- `davewhipp` is a tweaked version of `kjhealy`, with bigger fonts and dates
50-
right aligned
51-
52-
To change the default style, one needs to simply change the variable in the
52+
To change the default style, simply change the variable in the
5353
`_config.yml` file.
5454

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

57-
5857
### Author
5958

60-
Eliseo Papa ([Twitter](http://twitter.com/elipapa)/[GitHub](http://github.com/elipapa)/[website](https://elipapa.github.io)).
59+
Eliseo Papa ([Twitter](http://twitter.com/elipapa)/[Github](http://github.com/elipapa)/[Website](https://elipapa.github.io)).
6160

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

0 commit comments

Comments
 (0)