Skip to content

Commit b7d474c

Browse files
Merge pull request #1 from supercodingninja/gh-pages
Update
2 parents 51fa1e9 + 3a7c5a2 commit b7d474c

File tree

9 files changed

+40
-8
lines changed

9 files changed

+40
-8
lines changed

README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ A curriculum vitae maintained in plain text and rendered to HTML and PDF using C
44

55
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).
66

7-
***
87

98
## Customization
109

1110
Simply [fork the markdown-cv repo](https://github.com/elipapa/markdown-cv)
1211

13-
![](https://help.github.com/assets/images/help/repository/fork_button.jpg)
12+
![Git Help: Fork](https://help.github.com/assets/images/help/repository/fork_button.jpg)
1413

1514
and edit the `index.md` file [directly in Github](https://help.github.com/articles/editing-files-in-your-repository/)
1615

17-
![](https://help.github.com/assets/images/help/repository/edit-file-edit-button.png)
16+
![Git Help: Edit Button](https://help.github.com/assets/images/help/repository/edit-file-edit-button.png)
1817

1918
adding your skills, jobs and education.
2019

21-
![](https://help.github.com/assets/images/help/repository/edit-readme-light.png)
20+
![Git Help: ReadMe.md- light](https://help.github.com/assets/images/help/repository/edit-readme-light.png)
21+
2222

2323
## Distribution
2424

@@ -27,25 +27,33 @@ To transform your plain text CV into a beautiful and shareable HTML page, you ha
2727
### I. Use Github Pages to publish it online
2828

2929
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+
3031
2. Create a new branch called `gh-pages`.
32+
3133
3. Head to *yourusername*.github.io/markdown-cv to see your CV live.
3234

3335
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.
3436

3537
### II. Build it locally and print a PDF
3638

3739
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+
3943
3. Type `jekyll serve` to render your CV at http://localhost:4000.
44+
4045
4. You can edit the `index.md` file and see the changes live in your browser.
46+
4147
5. To print a PDF, press <kbd>⌘</kbd> + <kbd>p</kbd>. Print and web CSS media queries should take care of the styling.
4248

49+
4350
## Styling
4451

4552
The included CSS will render your CV in two styles:
4653
s
4754
1. `kjhealy` the original default, inspired by [kjhealy's vita
4855
template](https://github.com/kjhealy/kjh-vita).
56+
4957
2. `davewhipp` is a tweaked version of `kjhealy`, with bigger fonts and dates
5058
right aligned.
5159

@@ -54,12 +62,36 @@ To change the default style, simply change the variable in the
5462

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

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+
5772
### Author
5873

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))
6075

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

63-
### License
78+
### Contributors
79+
80+
<p align="center">
81+
<a href="https://github.com/aloupfor"><img src="media/Aloupfor.jpeg" height="120" width="120"/></a>&nbsp;&nbsp;&nbsp;<a href="https://github.com/blmoore"><img src="media/Ben.png" height="120" width="120"/></a>&nbsp;&nbsp;<a href="https://github.com/zpeterson"><img src="media/Zoe.jpeg" height="120" width="120"/></a><a href="https://github.com/supercodingninja" height="120" width="120"><img src="media/apple-touch-icon.png"/></a>
82+
</p>
83+
84+
<p align="left">
85+
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™
86+
</p>
87+
88+
## License
89+
![License Icon](https://img.shields.io/badge/License-MIT-informational.svg)
90+
91+
*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.
6496

65-
[MIT License](https://github.com/elipapa/markdown-cv/blob/master/LICENSE)
97+
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.

media/Aloupfor.jpeg

21.7 KB
Loading

media/Ben.png

295 KB
Loading

media/Fam.jpg

214 KB
Loading
4.19 KB
Loading

media/USMC.jpg

237 KB
Loading

media/Zoe.jpeg

15.5 KB
Loading

media/apple-touch-icon.png

24.7 KB
Loading

media/us.gif

61 MB
Loading

0 commit comments

Comments
 (0)