{"id":13845054,"url":"https://github.com/luyilin/Aoba","last_synced_at":"2025-07-12T00:32:59.382Z","repository":{"id":57181034,"uuid":"112990113","full_name":"luyilin/Aoba","owner":"luyilin","description":"Create a lovely resume just with a config file.","archived":false,"fork":false,"pushed_at":"2018-05-09T13:32:37.000Z","size":485,"stargazers_count":56,"open_issues_count":5,"forks_count":10,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-07T04:49:29.507Z","etag":null,"topics":["resume","resume-creator","vue"],"latest_commit_sha":null,"homepage":"https://luyilin.github.io/Aoba/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luyilin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-04T03:29:07.000Z","updated_at":"2022-12-21T13:24:36.000Z","dependencies_parsed_at":"2022-09-26T16:31:05.058Z","dependency_job_id":null,"html_url":"https://github.com/luyilin/Aoba","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luyilin%2FAoba","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luyilin%2FAoba/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luyilin%2FAoba/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luyilin%2FAoba/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luyilin","download_url":"https://codeload.github.com/luyilin/Aoba/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225772874,"owners_count":17521906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["resume","resume-creator","vue"],"created_at":"2024-08-04T17:03:09.118Z","updated_at":"2024-11-21T17:31:13.614Z","avatar_url":"https://github.com/luyilin.png","language":"Vue","funding_links":[],"categories":["Vue (45)","Vue"],"sub_categories":[],"readme":"# Aoba\n\n[Aoba's resume](https://luyilin.github.io/Aoba/)\n\n[English resume](https://luyilin.github.io/Aoba/resume-en)\n\n## Introduction\n\nAoba 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.\n\nThe project is build by [poi](https://github.com/egoist/poi), then we need not git clone \u0026\u0026 run build to create a resume, just use it. The design is inspired by the cute [resume](https://github.com/DIYgod/Resume) made by DIYgod. Thanks for the awesome work they done.\n\nThe 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.\n\n![Aoba Suzukaze](https://wx3.sinaimg.cn/mw690/a2117cdbly1fm7csm5gopj208z07ijvh.jpg)\n\n## Quick Start\n\n### Work with the single JavaScript file and the css file.\n\n* CDN: [UNPKG](https://unpkg.com/aoba-resume@latest/) | [jsDelivr](https://cdn.jsdelivr.net/npm/aoba-resume@latest/dist/)\n\n* Create an HTML file: `index.html` which will be be your resume:\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n\u003chead\u003e\n  \u003cmeta charset=\"utf-8\" /\u003e\n  \u003cmeta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"\u003e\n  \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0\" /\u003e\n  \u003ctitle\u003eMy resume\u003c/title\u003e\n  \u003c!-- Stylesheet --\u003e\n  \u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/aoba-resume/dist/aoba.css\"\u003e\n\u003c/head\u003e\n\u003cbody\u003e\n  \u003cdiv id=\"app\"\u003e\u003c/div\u003e\n  \u003c!-- Script --\u003e\n  \u003cscript src=\"https://cdn.jsdelivr.net/npm/aoba-resume/dist/aoba.js\"\u003e\u003c/script\u003e\n  \u003c!-- Start app --\u003e\n  \u003cscript\u003e\n    const resume = new aoba()\n    resume.start('#app')\n  \u003c/script\u003e\n\u003c/body\u003e\n\u003c/html\u003e\n```\n\n* Then write a .json or .yaml file at the same directory where `index.html` is located.\n\n  The file has six parts, basicInfo, contact, application, workExperience, personalProject and skills. See [content.json](https://github.com/luyilin/Aoba/blob/master/docs/content.json) or [content.yaml](https://github.com/luyilin/Aoba/blob/master/docs/content.yaml) for details.\n\n* Then serve this directory as a static website to deploy an online resume.\n\n  - node.js: `npm i -g serve` \u0026\u0026 `serve ./docs`\n  - python: `cd ./docs` \u0026\u0026 `python -m SimpleHTTPServer`\n  - golang: `cd ./docs` \u0026\u0026 `caddy`\n  - ...etc, you can use any static file server as you like.\n  \n* Finally save the file as pdf, open the file in a browser, choose print and save.\n\n  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.\n\n## Deploy\n\n### GitHub Pages\n\nSimply put all your files in `docs` folder on `master` branch, or root directory on the `gh-pages` branch.\n\nDon't forget to add `.nojekyll` file to tell GitHub to treat it as a normal static website.\n\n## API\n\n### Constructor\n\n```js\nconst resume = new aoba(options)\n```\n\n### options\n\n#### lang\n\nType: `string`\u003cbr\u003e\nDefault: `zh`\n\nsupport zh \u0026 en\n\n#### path \n\nType: `string`\u003cbr\u003e\nDefault: `./`\n\n#### indexFile\n\nType: `string`\u003cbr\u003e\nDefault: `content.yaml`\n\nThe configuration file.\n\nE.g. [content.json](https://github.com/luyilin/Aoba/blob/master/docs/content.json), [content.yaml](https://github.com/luyilin/Aoba/blob/master/docs/content.yaml)\n\nThe description fields support html syntax.\n\n#### color\n\nType: `string`\u003cbr\u003e\nDefault: `#8d9cd2`\n\nThe theme color. \n\nE.g. #999, rgb(137,214,217), lightsalmon and so on.\n\n### resume.start(target)\n\n#### target\n\nType: `string` `HTMLElement`\n\nThe place to mount app.\n\n## License\n\nMIT \u0026copy; [luyilin](http://github.com/luyilin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluyilin%2FAoba","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluyilin%2FAoba","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluyilin%2FAoba/lists"}