wc-resume

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 10)

A resume.json vanilla web component

wc-resume Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">&lt;wc-resume&gt; Embed a JSONResume</h1>

## Installation

*Installation*
```sh
npm i @vanillawc/wc-resume
```

*Import from NPM*
```html
<script type="module" src="node_modules/@vanillawc/wc-resume/index.js"></script>
```

*Import from CDN*
```html
<script type="module" src="https://cdn.jsdelivr.net/gh/vanillawc/wc-resume@2/index.js"></script>
```

## 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
<wc-resume src="resume.json"></wc-resume>
```

### 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
<wc-resume src="resume.json" theme="/path/to/theme/"></wc-resume>
```

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)

wc-resume

wc-resume Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

wc-resume

wc-resume Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README