luyilin/Aoba
Create a lovely resume just with a config file.
| repo name | luyilin/Aoba |
| repo link | https://github.com/luyilin/Aoba |
| homepage | https://luyilin.github.io/Aoba/ |
| language | Vue |
| size (curr.) | 485 kB |
| stars (curr.) | 58 |
| created | 2017-12-04 |
| license | MIT License |
Aoba
Introduction
Aoba is a single JavaScript file that fetches a configuration file (such as a .json file or a .yaml file), and renders it as a lovely one-page resume.
The project is build by poi, then we need not git clone && run build to create a resume, just use it. The design is inspired by the cute resume made by DIYgod. Thanks for the awesome work they done.
The name is inspired by lovely Aoba Suzukaze in New Game!, maybe it can be a gift for young people who enter the workforce, with my best wishes.
Quick Start
Work with the single JavaScript file and the css file.
<!DOCTYPE html>
<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, maximum-scale=1, user-scalable=0" />
<title>My resume</title>
<!-- Stylesheet -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/aoba-resume/dist/aoba.css">
</head>
<body>
<div id="app"></div>
<!-- Script -->
<script src="https://cdn.jsdelivr.net/npm/aoba-resume/dist/aoba.js"></script>
<!-- Start app -->
<script>
const resume = new aoba()
resume.start('#app')
</script>
</body>
</html>
-
Then write a .json or .yaml file at the same directory where
index.htmlis located.The file has six parts, basicInfo, contact, application, workExperience, personalProject and skills. See content.json or content.yaml for details.
-
Then serve this directory as a static website to deploy an online resume.
- node.js:
npm i -g serve&&serve ./docs - python:
cd ./docs&&python -m SimpleHTTPServer - golang:
cd ./docs&&caddy - …etc, you can use any static file server as you like.
- node.js:
-
Finally save the file as pdf, open the file in a browser, choose print and save.
In case the resume’s background color or the circles cannot be displayed when print to pdf, please tick the option: Print - More settings - Background.
Deploy
GitHub Pages
Simply put all your files in docs folder on master branch, or root directory on the gh-pages branch.
Don’t forget to add .nojekyll file to tell GitHub to treat it as a normal static website.
API
Constructor
const resume = new aoba(options)
options
lang
Type: string
Default: zh
support zh & en
path
Type: string
Default: ./
indexFile
Type: string
Default: content.yaml
The configuration file.
E.g. content.json, content.yaml
The description fields support html syntax.
color
Type: string
Default: #8d9cd2
The theme color.
E.g. #999, rgb(137,214,217), lightsalmon and so on.
resume.start(target)
target
Type: string HTMLElement
The place to mount app.
License
MIT © luyilin
