DEVELOPER.md · manoo/Best-Resume-Ever

# Developer Docs

Table of Contents

[Templates](#templates)

[Fonts](#fonts)

[Export](#export)

## Templates

In the directory `src/resumes` you will find all existing templates.

### Creating New Templates

1. Create a copy of `src/resumes/template.vue`.

2. Rename file and update template name:
```javascript
let name = 'TEMPLATE-NAME';
```

3. Import the newly added template in `src/resumes/resumes.js`.

<br>
Your new resume will be now reachable at localhost:8080/#/resume/TEMPLATE-NAME.
<br>
<br>

5. Export resumes as PDF with `npm run export`. Verify export of new template.

4. Generate previews by converting PDF-files to PNG-files with `npm run preview`.

5. Add preview to `/src/pages/home.vue`:
```javascript
<div class="preview">
  <router-link v-bind:to="'/resume/TEMPLATE-NAME'">
    <div class="preview-wrapper">
      <img src="../assets/preview/TEMPLATE-NAME.png" />
      <span>left-right</span>
    </div>
  </router-link>
</div>
```

## Fonts

### Icons

This project contains the [Material Design](https://github.com/google/material-design-icons) and [Font Awesome](https://github.com/FortAwesome/Font-Awesome) icon sets.

### Included Fonts

These fonts are included:

- Open Sans, Open Sans Condensed

- Raleway

- Roboto

- Source Sans Pro

### Adding a New Font

All fonts are installed via npm. To add a new font, search for the associated npm-module. Add the module to the package.json and install it. Import the css file in `src/App.vue`.
<br>
<br>

## Export

Resumes are being exported with [Puppeteer](https://github.com/GoogleChrome/puppeteer).

### Box Shadows

[Electroshot](https://github.com/mixu/electroshot) uses Electron to generate PDF-files. Since Chrome does not export box-shadows properly, every resume uses [chrome-shadow-fixer](https://github.com/salomonelli/chrome-shadow-fixer).

manoo/Best-Resume-Ever

简介

发行版

贡献者

近期动态

manoo/Best-Resume-Ever .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

manoo/Best-Resume-Ever