Skip to content

Commit

Permalink
add some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elipapa committed Jun 14, 2018
1 parent 465dc8a commit abe792c
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ 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) 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](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/#deleting-a-branch)
2. Create a new branch called `gh-pages` (which will then be a copy of master)
Expand All @@ -32,18 +32,27 @@ To transform your plain text CV into a beautiful looking HTML page and share it
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
## 2) Build it locally and print a PDF
1. [install jekyll](https://jekyllrb.com/docs/installation/) 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?
### Change the style

For the moment, yes.
The included CSS renders CV in a style inspired by [kjhealy's vita template](https://github.com/kjhealy/kjh-vita), but any styling is possible. Contributions and forks are welcome!
The included CSS renders CV in different styles:

- `kjhealy` the original default, inspired by [kjhealy's vita
template](https://github.com/kjhealy/kjh-vita)
- `davewhipp` is a tweaked version of `kjhealy`, with bigger fonts and dates
right aligned

To change the default style, one needs to simply change the variable in the
`_config.yml` file.

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


### Author
Expand Down

0 comments on commit abe792c

Please sign in to comment.