https://github.com/vanillawc/wc-resume
A resume.json vanilla web component
https://github.com/vanillawc/wc-resume
resume vanilla web-components
Last synced: about 1 year ago
JSON representation
A resume.json vanilla web component
- Host: GitHub
- URL: https://github.com/vanillawc/wc-resume
- Owner: vanillawc
- License: mit
- Created: 2019-12-09T02:05:27.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2021-05-16T17:20:10.000Z (about 5 years ago)
- Last Synced: 2025-03-20T18:11:15.619Z (about 1 year ago)
- Topics: resume, vanilla, web-components
- Language: JavaScript
- Size: 608 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
<wc-resume> Embed a JSONResume
## Installation
*Installation*
```sh
npm i @vanillawc/wc-resume
```
*Import from NPM*
```html
```
*Import from CDN*
```html
```
## Demo
Try it on [WebComponents.dev](https://webcomponents.dev/edit/DUcJnEutaKbTPYqkcuYX?sv=1&pm=1)
## Usage
**Attributes**
- `src` - The source resume.json file
- `theme` - Path to a resume theme directory
### Load `resume.json`
```html
```
### Theming
Resume themes are made up of a collection of partials and a `styles.css` file. To select a theme point to its directory using the `theme` attribute.
```html
```
Themes can be found in the `themes/` directory.
**Themes**
- Default
- Compact
- Positive
## Building Custom Theme
Themes are defined as a collection of partials written in [tagged template literal][] syntax
A complete theme is defined as a directory of the following files
```sh
theme
├── about.html
├── awards.html
├── contact.html
├── education.html
├── interests.html
├── languages.html
├── profiles.html
├── projects.html
├── publications.html
├── references.html
├── skills.html
├── style.css
├── volunteer.html
└── work.html
```
`styles.css` is where the theme's CSS styling is defined
[tagged template literal]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals
## Contributing
See [CONTRIBUTING.md](https://github.com/vanillawc/vanillawc/blob/main/CONTRIBUTING.md)