From 8628f05432101848b4b03b27f23393a2ed744c65 Mon Sep 17 00:00:00 2001 From: unpregnant Date: Mon, 13 Feb 2017 20:32:56 +0100 Subject: [PATCH] FIX spacing readme --- README.md | 23 +++++++++++------------ index.html | 21 +++++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index ccde416..ec829aa 100755 --- a/README.md +++ b/README.md @@ -16,27 +16,26 @@ A collection of multiple beautiful resumes build with LESS and Mustache Template - - +
## Getting Started Follow these instructions to set up this project and create your own CV. -

+
### Prerequisites To run this project, please install node. (See https://nodejs.org/en/download/package-manager/ and https://nodejs.org/en/download/) -

+
### Installation - Clone this repository. - Switch to project directory and run `npm install`. -

+
### Adjusting your personal information @@ -46,7 +45,7 @@ To run this project, please install node. (See https://nodejs.org/en/download/pa 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! -

+
### Exporting resumes as PDF @@ -54,7 +53,7 @@ With `npm run pdf` the resumes can be exported. You will find all resumes as PDF [electroshot](https://github.com/mixu/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](https://github.com/mixu/electroshot). -

+
### Adjusting stylings and layout @@ -62,13 +61,13 @@ This project uses LESS. Under `/less` global stylings are defined. You will find 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. -

+
### Icons This project contains the [Google Material](https://material.io/icons/) and [fontawesome](http://fontawesome.io/icons/) icon sets. -

+
### CSS3 Box-Shadows @@ -88,7 +87,7 @@ Unfortunately, fonts and images get blurred and lose quality. Therefore `fixBoxS If shadows may be displayed wrong, please check that the element with a box-shadow has a proper height, width and positioning. -

+
### Adding fonts @@ -117,7 +116,7 @@ Import new less file in `/less/fonts.less`: @import "fonts/roboto.less"; ``` -

+
## Adding a template @@ -136,7 +135,7 @@ Sample content of `index.mustache`: For further reference, check out existing templates. -

+
## Contribute diff --git a/index.html b/index.html index f40bed6..bca9d9b 100755 --- a/index.html +++ b/index.html @@ -23,18 +23,19 @@

+


Getting Started

Follow these instructions to set up this project and create your own CV.

-



+


Prerequisites

To run this project, please install node. (See https://nodejs.org/en/download/package-manager/ and https://nodejs.org/en/download/)

-



+


Installation

-



+


Adjusting your personal information

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!

-



+


Exporting resumes as PDF

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.

-



+


Adjusting stylings and layout

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.

-



+


Icons

This project contains the Google Material and fontawesome icon sets.

-



+


CSS3 Box-Shadows

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;
@@ -67,7 +68,7 @@
 
  • and adding the stylings for -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.
    
-


    
+

    
 
    Adding fonts
    
 
    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:
    
@@ -87,7 +88,7 @@
 @import "fonts/material-design-icons.less";
 @import "fonts/roboto.less";
    -



    +


    Adding a template

    Follow these steps: