diff --git a/index.html b/index.html deleted file mode 100755 index 64e15fc..0000000 --- a/index.html +++ /dev/null @@ -1,116 +0,0 @@ - - -
- - - - -
Build your best resume ever!
-A collection of multiple beautiful resumes build with LESS and Mustache Templates. Choose your favorite Curriculum Vitae and easily export it as PDF.
-Follow these instructions to set up this project and create your own CV.
-To run this project, please install node. (See https://nodejs.org/en/download/package-manager/ and https://nodejs.org/en/download/)
-npm install./src/person.js./public/person.jpg with your portrait.npm run dev. Check out http://localhost:3000.Everytime you make changes, the app recompiles automatically. This may take a short while. Feel free to adjust font-sizes and other stylings to fit your needs!
-With npm run pdf the resumes can be exported. You will find all resumes as PDFs in /pdf.
electroshot is used to generate PDFs. convertToPdf() in /src/htmlToPdf.js runs a short bash script for each resume running under localhost:3000/resumes/resume-X. By default the PDF size is A4. For more PDF settings check mixu/electroshot.
This project uses LESS. Under /less global stylings are defined. You will find here imported fonts and the page layout.
Each resume has its own directory. For example 'resume-1' is under /resumes/resume-1. Each resume directory contains a Mustache template and a less-file.
This project contains the Google Material and fontawesome icon sets.
-Due to this Chrome bug, CSS3 box-shadows are not rendered properly in the PDF files. The solution is to add this styling to elements with box-shadows:
--webkit-print-color-adjust:exact;
--webkit-filter:opacity(1);
-
-Unfortunately, fonts and images get blurred and lose quality. Therefore fixBoxShadows() in /src/javascript.js fixes this bug, by
-webkit-print-color-adjust and -webkit-filter to the new element.If shadows may be displayed wrong, please check that the element with a box-shadow has a proper height, width and positioning.
-To add a font to the project, search for the npm-module of the desired font, e.g. roboto-fontface for 'Roboto'. Add dependency to package.json with npm i --save, e.g. npm i --save roboto-fontface.
Create a new less file in /less/fonts, e.g. 'roboto.less'. /node_modules are accessable through localhost:3000. That means if the corresponding woff-file is under /node_modules/roboto-fontface/anyFont.woff the source url needs to equal /roboto-fontface/anyFont.woff:
@font-face {
- font-family: 'Roboto';
- src: url('/roboto-fontface/fonts/Roboto/Roboto-Thin.eot');
- src: local('Roboto Thin'), local('Roboto-Thin'), url('/roboto-fontface/fonts/Roboto/Roboto-Thin.woff') format('woff'), url('/roboto-fontface/fonts/Roboto/Roboto-Thin.ttf') format('truetype')
- font-weight: 100;
- font-style: normal;
-}
-
-Import new less file in /less/fonts.less:
@import "fonts/opensans.less";
-@import "fonts/montserrat.less";
-@import "fonts/raleway.less";
-@import "fonts/opensans-condensed.less";
-@import "fonts/material-design-icons.less";
-@import "fonts/roboto.less";
-
-Follow these steps:
-style.less and index.mustache with same naming inside new folderSample content of index.mustache:
<page class="a4">
- <div id="resume1" class="resume">
- <!-- Content goes here -->
- </div>
-</page>
-
-For further reference, check out existing templates.
-Feel free to create your own templates. Please read this documentation carefully. After adding your template please add a preview as in /public/preview and add it to the README. Compile index.html for github Pages with npm run readme. If needed, adjust styling of github Pages in /less/githubPages.less.