106 lines
6.3 KiB
HTML
Executable File
106 lines
6.3 KiB
HTML
Executable File
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<link href="public/style.min.css" rel=" stylesheet">
|
|
<title> Best resume ever </title>
|
|
</head>
|
|
|
|
<body>
|
|
<a href="https://github.com/SalamiMitPizza/best-resume-ever" target="_blank">
|
|
<div id="forkme">View on Github <img src="public/github.png" /></div>
|
|
</a>
|
|
<div id="readme">
|
|
<h1 id="bestresumeever">best-resume-ever</h1>
|
|
<p>Build your best resume ever!</p>
|
|
<p>A collection of multiple beautiful resumes build with LESS and Mustache Templates. Choose your favorite Curriculum Vitae and easily export it as PDF.</p>
|
|
<h2 id="resumes">Resumes</h2>
|
|
<p><a href="public/preview/resume-1.png"><img src="public/preview/resume-1.png" width="150"/></a>
|
|
<a href="public/preview/resume-2.png"><img src="public/preview/resume-2.png" width="150"/></a>
|
|
<a href="public/preview/resume-3.png"><img src="public/preview/resume-3.png" width="150"/></a>
|
|
<a href="public/preview/resume-4.png"><img src="public/preview/resume-4.png" width="150"/></a>
|
|
<a href="public/preview/resume-5.png"><img src="public/preview/resume-5.png" width="150"/></a>
|
|
<a href="public/preview/resume-6.png"><img src="public/preview/resume-6.png" width="150"/></a></p>
|
|
<h2 id="gettingstarted">Getting Started</h2>
|
|
<p>Follow these instructions to set up this project and create your own CV.</p>
|
|
<h3 id="prerequisites">Prerequisites</h3>
|
|
<p>To run this project, please install node.</p>
|
|
<p>See:</p>
|
|
<ul>
|
|
<li>https://nodejs.org/en/download/package-manager/</li>
|
|
<li>https://nodejs.org/en/download/</li>
|
|
</ul>
|
|
<h3 id="installation">Installation</h3>
|
|
<ul>
|
|
<li>Clone this repository.</li>
|
|
<li>Switch to project directory and run <code>npm install</code>.</li>
|
|
</ul>
|
|
<h3 id="adjustingyourpersonalinformation">Adjusting your personal information</h3>
|
|
<ul>
|
|
<li>Adjust your personal information in <code>/src/person.js</code>.</li>
|
|
<li>Replace placeholder image <code>/public/person.jpg</code> with your portrait.</li>
|
|
<li>To preview your CV run <code>npm start</code>. Check out <a href="http://localhost:3000">http://localhost:3000</a>.</li>
|
|
</ul>
|
|
<p>If you adjust your data in <code>/src/person.js</code>, please stop application with <code>CTRL + C</code> and restart with <code>npm start</code>.</p>
|
|
<h3 id="exportingresumesaspdf">Exporting resumes as PDF</h3>
|
|
<p>When finished, run <code>npm start</code> and run <code>npm run PDF</code> in a new console window to generate resumes as PDF. You will find the all resumes as PDFs in <code>/pdf</code>.</p>
|
|
<h3 id="adjustingstylingsandlayout">Adjusting stylings and layout</h3>
|
|
<p>Feel free to adjust stylings. This project uses LESS. Under <code>/less</code> global stylings are defined. Concerning the resumes, you will find here imported fonts and the page layout. To see how to adjust the page layout see 'Page size'. To add fonts see 'Add fonts'.</p>
|
|
<p>Each resume has its own directory. For example 'resume-1' is under <code>/resumes/resume-1</code>. Each resume directory contains a Mustache template and a less-file. Font-sizes and box-shadows are being adjusted automatically. Therefore please read: XX and XX.</p>
|
|
<h4 id="fontsizes">Font-Sizes</h4>
|
|
<p>Font-sizes adjust automatically depending on how much content your resume has. The bottom margin of the content is defined in <code>/public/javascript.js</code>:</p>
|
|
<pre><code class="javascript language-javascript">// minimum margin of content to bottom of page
|
|
var marginBottom = 50; // in px
|
|
</code></pre>
|
|
<p>If you do not want the font-size of an element to adjust automatically, please use <code>!important</code>:</p>
|
|
<pre><code class="css language-css">.anyFont {
|
|
font-size: 12px !important;
|
|
}
|
|
</code></pre>
|
|
<p>If you want to deactivate the automatic font adjustment just remove this line from <code>/public/javascript.js</code>:</p>
|
|
<pre><code class="javascript language-javascript">checkFont();
|
|
</code></pre>
|
|
<h4 id="css3boxshadows">CSS3 Box-Shadows</h4>
|
|
<p>Due to this <a href="http://stackoverflow.com/questions/13975198/text-shadow-and-box-shadow-while-printing-chrome">Chrome bug</a>, CSS3 box-shadows are not rendered properly in the PDF files. The solution is to add this styling to elements with box-shadows:</p>
|
|
<pre><code class="css language-css">-webkit-print-color-adjust:exact;
|
|
-webkit-filter:opacity(1);
|
|
</code></pre>
|
|
<p>Unfortunately, fonts and images get blurred and lose quality. Therefore <code>fixBoxShadows()</code> in <code>/public/javascript.js</code> fixes this bug, by</p>
|
|
<ol>
|
|
<li>searching for all elements with a box-shadow,</li>
|
|
<li>removing the box-shadow,</li>
|
|
<li>adding a new and absolute positioned element (with same size, position, border-radius and box-shadow) to the HTMl body,</li>
|
|
<li>and adding the stylings for <code>-webkit-print-color-adjust</code> and <code>-webkit-filter</code> to the new element.</li>
|
|
</ol>
|
|
<p>If shadows may be displayed wrong, please check that the element with a box-shadow has a proper height, width and positioning;</p>
|
|
<h3 id="adjustingpdfgenerationandpagesize">Adjusting PDF-generation and page size</h3>
|
|
<p><a href="https://github.com/mixu/electroshot">mixu/electroshot</a> is used to generate PDFs. <code>convertToPdf()</code> in <code>/src/htmlToPdf.js</code> runs a short bash script for each resume running under <code>localhost:3000/resumes/resume-X</code>. By default PDF equals A4. For more PDF settings check <a href="https://github.com/mixu/electroshot">mixu/electroshot</a>.</p>
|
|
<h3 id="addingfonts">Adding fonts</h3>
|
|
<p>TODO</p>
|
|
<h2 id="addingatemplate">Adding a template</h2>
|
|
<p>TODO</p>
|
|
<h2 id="buildwith">Build With</h2>
|
|
<ul>
|
|
<li>LESS</li>
|
|
<li>Mustache</li>
|
|
<li>Babel</li>
|
|
<li>electroshot</li>
|
|
<li>Node.js, JavaScript.</li>
|
|
</ul>
|
|
<p>TODO add readme to html!</p>
|
|
<h2 id="contribute">Contribute</h2>
|
|
<p>Feel free to create your own templates!
|
|
TODO add contribute.md on how to contribute</p>
|
|
<hr />
|
|
<p>Icons made by <a href="http://www.flaticon.com/authors/vectors-market" title="Vectors Market">Vectors Market</a> from <a href="http://www.flaticon.com" title="Flaticon">www.flaticon.com</a> is licensed by <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0">CC 3.0 BY</a>.</p>
|
|
</div>
|
|
<script>
|
|
var headline = document.getElementsByTagName('h1')[0];
|
|
headline.innerHTML += '<img src="public/suitcase.png" width="150" />';
|
|
</script>
|
|
</body>
|
|
|
|
</html>
|