aoba-resume
Advanced tools
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.
<!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.html is 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.
npm i -g serve && serve ./docscd ./docs && python -m SimpleHTTPServercd ./docs && caddyFinally 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.
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.
const resume = new aoba(options)
Type: string
Default: zh
support zh & en
Type: string
Default: ./
Type: string
Default: content.yaml
The configuration file.
E.g. content.json, content.yaml
The description fields support html syntax.
Type: string
Default: #8d9cd2
The theme color.
E.g. #999, rgb(137,214,217), lightsalmon and so on.
Type: string HTMLElement
The place to mount app.
MIT © luyilin
FAQs
Create a lovely resume just with a config file.
We found that aoba-resume demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.