ADD auto render readme
This commit is contained in:
salamimitpizza
parent
9fcd43e303
commit
d0cb3d7547
@ -6,8 +6,8 @@ A collection of beautiful resumes build with LESS and Mustache Templates. Choose
|
||||
|
||||
## Resumes
|
||||
|
||||
<img src="public/preview/resume-1.png" width="150"/>
|
||||
<img src="public/preview/resume-2.png" width="150"/>
|
||||
<img src="resumes/resume-1/resume-1.png" width="150"/>
|
||||
<img src="resumes/resume-1/resume-2.png" width="150"/>
|
||||
|
||||
## Install
|
||||
|
||||
|
||||
59
index.html
59
index.html
@ -4,41 +4,36 @@
|
||||
<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="/font-awesome/css/font-awesome.min.css" rel="stylesheet">
|
||||
<link href="public/style.min.css" rel="stylesheet">
|
||||
<title>Best resume ever</title>
|
||||
<link href="public/style.min.css" rel=" stylesheet">
|
||||
<title> Best resume ever </title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="index-page">
|
||||
<header>
|
||||
<a href="https://github.com/SalamiMitPizza/best-resume-ever" target="_blank">
|
||||
<div id="forkme">View on Github <i class="fa fa-github"></i></div>
|
||||
</a>
|
||||
<div class="content">
|
||||
<div class="logo">
|
||||
<i class="fa fa-briefcase"></i>
|
||||
<h1>
|
||||
best-resume-ever
|
||||
</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<main>
|
||||
<section class="resume-collection">
|
||||
<h3>Resumes</h3>
|
||||
<div class="resume">
|
||||
<img src="public/preview/resume-1.png" />
|
||||
<span class="resume-title">Resume 1</span>
|
||||
</div>
|
||||
<div class="resume">
|
||||
<img src="public/preview/resume-2.png" />
|
||||
<span class="resume-title">Resume 2</span>
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
|
||||
<h1 id="bestresumeever">best-resume-ever</h1>
|
||||
<p>Build your best resume ever!</p>
|
||||
<p>A collection of 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><img src="resumes/resume-1/resume-1.png" width="150"/>
|
||||
<img src="resumes/resume-1/resume-2.png" width="150"/></p>
|
||||
<h2 id="install">Install</h2>
|
||||
<p>Follow these instructions to create your own CV:</p>
|
||||
<ul>
|
||||
<li>Clone this repository.</li>
|
||||
<li>Switch to project directory and run <code>npm install</code>.</li>
|
||||
<li>Adjust your personal information in <code>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>
|
||||
<li>Feel free to adjust styles in <code>/less</code> according to your needs.</li>
|
||||
<li>When finished, run <code>npm run pdf</code> to generate all CVs as pdf. You will find the generated pdfs in <code>/pdf</code>.</li>
|
||||
</ul>
|
||||
<h2 id="addingatemplate">Adding a template</h2>
|
||||
<p>TODO</p>
|
||||
<h2 id="howtoaddafont">How to add a font</h2>
|
||||
<p>TODO</p>
|
||||
<h2 id="contribute">Contribute</h2>
|
||||
<p>Feel free to create your own templates!</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>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
||||
@ -10,6 +10,7 @@
|
||||
"pdf:win": "sh scripts/createPDF.sh",
|
||||
"png": "npm run pdf && bash scripts/createPNG.bash",
|
||||
"png:win": "npm run pdf:win && sh scripts/createPNG.sh",
|
||||
"readme": "node renderReadMe.js",
|
||||
"less": "lessc --clean-css less/style.less public/style.min.css"
|
||||
},
|
||||
"repository": {
|
||||
@ -19,6 +20,7 @@
|
||||
"author": "salamimipizza",
|
||||
"homepage": "https://salamimitpizza.github.io/beautifulCV/",
|
||||
"dependencies": {
|
||||
"buffer-to-string": "^0.1.0",
|
||||
"electron": "^1.4.15",
|
||||
"electroshot": "^1.2.0",
|
||||
"express": "^4.14.1",
|
||||
@ -29,10 +31,14 @@
|
||||
"less": "^2.7.2",
|
||||
"less-plugin-clean-css": "^1.5.1",
|
||||
"local-web-server": "1.2.6",
|
||||
"markdown-to-html": "0.0.13",
|
||||
"mustache": "^2.3.0",
|
||||
"mustache-express": "^1.2.4",
|
||||
"open-sans-fontface": "^1.4.0",
|
||||
"path": "^0.12.7",
|
||||
"pdf-to-png": "^1.0.3",
|
||||
"raleway-webfont": "^3.0.1"
|
||||
"raleway-webfont": "^3.0.1",
|
||||
"showdown": "^1.6.3",
|
||||
"write": "^0.3.2"
|
||||
}
|
||||
}
|
||||
|
||||
18
renderReadMe.js
Normal file
18
renderReadMe.js
Normal file
@ -0,0 +1,18 @@
|
||||
var showdown = require('showdown'),
|
||||
converter = new showdown.Converter();
|
||||
var fs = require('fs');
|
||||
var Mustache = require('mustache');
|
||||
var writeFile = require('write');
|
||||
|
||||
fs.readFile('README.md', 'utf-8', function(err, data) {
|
||||
if (err) console.log(err);
|
||||
var readme = converter.makeHtml(data);
|
||||
fs.readFile('resumes/readme.mustache', 'utf-8', function(err, template) {
|
||||
var html = Mustache.render(template, {
|
||||
content: readme
|
||||
});
|
||||
writeFile('index.html', html, function(err) {
|
||||
if (err) console.log(err);
|
||||
});
|
||||
});
|
||||
});
|
||||
15
resumes/readme.mustache
Normal file
15
resumes/readme.mustache
Normal file
@ -0,0 +1,15 @@
|
||||
<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>
|
||||
{{{content}}}
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user