You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+40-8Lines changed: 40 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,21 @@ A curriculum vitae maintained in plain text and rendered to HTML and PDF using C
4
4
5
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
6
7
-
***
8
7
9
8
## Customization
10
9
11
10
Simply [fork the markdown-cv repo](https://github.com/elipapa/markdown-cv)
@@ -27,25 +27,33 @@ To transform your plain text CV into a beautiful and shareable HTML page, you ha
27
27
### I. Use Github Pages to publish it online
28
28
29
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
+
30
31
2. Create a new branch called `gh-pages`.
32
+
31
33
3. Head to *yourusername*.github.io/markdown-cv to see your CV live.
32
34
33
35
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
36
35
37
### II. Build it locally and print a PDF
36
38
37
39
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.
40
+
41
+
2.[Clone](https://help.github.com/en/articles/cloning-a-repository) your fork of markdown-cv to your local machine.
42
+
39
43
3. Type `jekyll serve` to render your CV at http://localhost:4000.
44
+
40
45
4. You can edit the `index.md` file and see the changes live in your browser.
46
+
41
47
5. To print a PDF, press <kbd>⌘</kbd> + <kbd>p</kbd>. Print and web CSS media queries should take care of the styling.
42
48
49
+
43
50
## Styling
44
51
45
52
The included CSS will render your CV in two styles:
46
53
s
47
54
1.`kjhealy` the original default, inspired by [kjhealy's vita
2.`davewhipp` is a tweaked version of `kjhealy`, with bigger fonts and dates
50
58
right aligned.
51
59
@@ -54,12 +62,36 @@ To change the default style, simply change the variable in the
54
62
55
63
Any other styling is possible. More CSS style contributions and forks are welcome!
56
64
65
+
66
+
## References
67
+
###### [Back to Table of Contents](#Table-of-Contents)
68
+
1.[Shields IO](https://shields.io/) provides documentations on how to add your shield, for creditbility. Please feel free to view this resource, for your future developments.
69
+
70
+
2.[Markdown Syntax](https://www.markdownguide.org/basic-syntax/) provides documentations on how to add your shield, for creditbility. Please feel free to view this resource, for your future developments.
71
+
57
72
### Author
58
73
59
-
Eliseo Papa ([Twitter](http://twitter.com/elipapa)/[Github](https://github.com/elipapa)/[Website](https://elipapa.github.io)).
74
+
Eliseo Papa ([Twitter](http://twitter.com/elipapa)/[Github](https://github.com/elipapa)/[Website](https://elipapa.github.io))
Select images above to visit the contributor's GitHub Profile. Names following images left to right: aloupfor, Benjamin L. Moore,Zoë Peterson,and Frederick Thomas, Super Coding Ninja™
*markdown-cv* Copyright (c) [2021][Eliseo Papa](https://github.com/elipapa), and [Frederick Thomas](https://github.com/supercodingninja)
92
+
93
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
94
+
95
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0 commit comments