Skip to content

Commit

Permalink
🎉 initial setup
Browse files Browse the repository at this point in the history
  • Loading branch information
scottnath committed May 14, 2024
1 parent 1db688e commit e8b2517
Show file tree
Hide file tree
Showing 4 changed files with 235 additions and 2 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Release
on:
push:
branches:
- main
- next

permissions:
contents: read # for checkout

jobs:
release:
name: Release
runs-on: ubuntu-latest
permissions:
contents: write # to be able to publish a GitHub release
issues: write # to be able to comment on released issues
pull-requests: write # to be able to comment on released pull requests
id-token: write # to enable use of OIDC for npm provenance
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: pnpm/action-setup@v4
with:
version: 8
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 'lts/*'
- name: Install dependencies
run: pnpm install
- name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
run: npm audit signatures
- name: Release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npm run release
3 changes: 3 additions & 0 deletions .releaserc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default {
extends: 'storydocker-utilities/releases',
}
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# jsonresume-theme-web-component
Both a web component and a json resume theme with microdata
# jsonresume-web-component

A web component (using LitElement) which presents resume content stored in [JSON Resume][jsonresume] format. The HTML structure uses the methods in [jsonresume-theme-microdata][jtm] to generate HTML which includes structured data as microdata in HTML attributes.

## Installation

```javascript
npm i jsonresume-web-component
```

## A modified JSON Resume schema

The JSON structure follows an extension of the [JSON Resume][jsonresume] schema with added schema structure for microdata `itemtype` on some content types, `basics.pronouns`, and `meta.sectionTitles` which allows changing the content of the resume section titles. See the [jsonresume-theme-microdata][jtm] README for details on this adjusted structure.


[microdata-html]: /blahg/microdata-with-html/
[microdata-jsonresume]: /blahg/microdata-with-jsonresume/
[jsonresume]: https://jsonresume.org
[jsonresume-schema]: https://github.com/jsonresume/resume-schema/blob/master/schema.json
[jsonresume-project]: https://jsonresume.org/projects/
[jtm]: https://github.com/scottnath/jsonresume-theme-microdata
[jtm-example]: https://github.com/scottnath/jsonresume-theme-microdata/TBD___
[jte]: https://github.com/rbardini/jsonresume-theme-even
169 changes: 169 additions & 0 deletions src/fixtures/lorem.resume.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
{
"basics": {
"name": "MC Fluff NStuff",
"label": "Very Professional Title",
"image": "https://placekitten.com/300/300",
"email": "[email protected]",
"phone": "212-555-1212",
"url": "https://example.com",
"pronouns": "they/them",
"summary": "Cat ipsum dolor sit amet, be the most annoying cat that you can, and, knock everything off the table but commence midnight zoomies. Scratch at fleas, meow until belly rubs, hide behind curtain when vacuum cleaner is on scratch strangers and poo on owners food you call this cat food chirp at birds, decide to want nothing to do with my owner today yet gnaw the corn cob so chase the pig around the house.",
"location": {
"address": "1234 Street Lane",
"postalCode": "10001",
"city": "NYC",
"countryCode": "US",
"region": "NorthEast"
},
"profiles": [
{
"network": "MySpace",
"username": "user12345678",
"url": "https://myspace.com/user12345678"
},
{
"network": "friendster",
"username": "meow_user_Af1544erxr",
"url": "https://friendster.com/meow_user_Af1544erxr"
}
]
},
"skills": [
{
"name": "Skill One",
"level": "Amazing",
"keywords": [
"Things", "Stuff", "Activities"
]
},
{
"name": "Skill Two",
"level": "Fantastical",
"keywords": [
"Meow", "Plow", "Pazow", "Cacao"
]
}
],
"work": [
{
"company": "Company ABC",
"location": "",
"description": "",
"position": "Position or role",
"website": "http://company.example.com",
"startDate": "2020-03",
"endDate": "2024-03",
"summary": "Cat ipsum dolor sit amet, eat fish on floor. Inspect anything brought into the house scratch at fleas, meow until belly rubs, hide behind curtain when vacuum cleaner is on scratch strangers and poo on owners food so hiding behind the couch until lured out by a feathery toy. Pooping rainbow while flying in a toasted bread costume in space. Fall over dead (not really but gets sypathy) go crazy with excitement when plates are clanked together signalling the arrival of cat food and do doodoo in the litter-box, clickityclack on the piano, be frumpygrumpy, for stinky cat hiiiiiiiiii feed me now. Slap owner's face at 5am until human fills food dish paw at your fat belly yet missing until dinner time, or cat fur is the new black and hunt anything. ",
"highlights": [
"Highlight one",
"Highlight two"
]
}
],
"projects": [
{
"name": "Project ABC",
"description": "The project is Car rides are evil swat turds around the house poop on the floor, break a planter, sprint, eat own hair, vomit hair, hiss, chirp at birds, eat a squirrel, hide from fireworks, lick toe beans, attack christmas tree. Chase dog then run away allways wanting food. Fat baby cat best buddy little guy stare at the wall, play with food and get confused by dust for stare at imaginary bug. ",
"highlights": [
"Thing that happened one",
"Highlighted thing two"
],
"keywords": [
"Keyword-a",
"Keyword-b"
],
"startDate": "2024-01",
"endDate": "2024-05",
"website": "https://project.example.com",
"roles": [
"Breathing",
"Being"
],
"entity": "Entity ABC",
"type": "Open Source"
}
],
"volunteer": [
{
"organization": "Volunteer Organization",
"position": "Unpaid Position",
"website": "http://volunteer.example.com",
"startDate": "2024-01",
"endDate": "2024-04",
"summary": "Cat ipsum dolor sit amet, eat fish on floor. Cat not kitten around . Car rides are evil swat turds around the house poop on the floor, break a planter, sprint, eat own hair, vomit hair, hiss, chirp at birds, eat a squirrel, hide from fireworks, lick toe beans, attack christmas tree. Chase dog then run away allways wanting food. Fat baby cat best buddy little guy stare at the wall, play with food and get confused by dust for stare at imaginary bug. ",
"highlights": [
"Highlight abc",
"Highlight xyz"
]
}
],
"education": [
{
"institution": "School of Things and Stuff",
"area": "Things",
"studyType": "Masters",
"startDate": "2016-08",
"endDate": "",
"gpa": "4.5",
"courses": [
"Course one",
"Course two"
]
}
],
"awards": [
{
"title": "The Best at the Thing",
"date": "2024-02",
"awarder": "The Award Warehouse",
"summary": "Cat ipsum dolor sit amet, be the most annoying cat that you can, and, knock everything off the table but commence midnight zoomies. Scratch at fleas, meow until belly rubs, hide behind curtain when vacuum cleaner is on scratch strangers and poo on owners food you call this cat food chirp at birds, decide to want nothing to do with my owner today yet gnaw the corn cob so chase the pig around the house."
}
],
"publications": [
{
"name": "How I wrote fake content and used it in JSON Resume",
"publisher": "The Fake Meow Times",
"releaseDate": "2024-05",
"website": "https://publisher.example.com",
"summary": "Cat ipsum dolor sit amet, eat fish on floor. Inspect anything brought into the house scratch at fleas, meow until belly rubs, hide behind curtain when vacuum cleaner is on scratch strangers and poo on owners food so hiding behind the couch until lured out by a feathery toy."
}
],
"languages": [
{
"language": "English",
"fluency": "Native"
},
{
"language": "Gibberish",
"fluency": "[inaudible mumbling]"
},
{
"language": "Cat",
"fluency": "tolerated"
}
],
"interests": [
{
"name": "I like things",
"keywords": [
"Like stuff",
"Like things"
]
}
],
"references": [
{
"name": "John Doe",
"reference": "Fall over dead (not really but gets sypathy) go crazy with excitement when plates are clanked together signalling the arrival of cat food and do doodoo in the litter-box, clickityclack on the piano, be frumpygrumpy, for stinky cat hiiiiiiiiii feed me now. "
},
{
"name": "Jane Doe",
"reference": "I show my fluffy belly but it's a trap! if you pet it i will tear up your hand throwup on your pillow. Stare at ceiling yowling nonstop the whole night i shredded your linens for you i cry and cry and cry unless you pet me, and then maybe i cry just for fun. Cat not kitten around ."
}
],
"meta": {
"canonical": "",
"version": "",
"lastModified": ""
}
}

0 comments on commit e8b2517

Please sign in to comment.