https://github.com/observeroftime/jsonresume-theme-relaxed
A JSON Resume theme optimised for PDF output
https://github.com/observeroftime/jsonresume-theme-relaxed
hacktoberfest jsonresume jsonresume-theme resume resume-template
Last synced: about 1 month ago
JSON representation
A JSON Resume theme optimised for PDF output
- Host: GitHub
- URL: https://github.com/observeroftime/jsonresume-theme-relaxed
- Owner: ObserverOfTime
- License: mpl-2.0
- Created: 2023-07-08T16:52:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-20T08:29:02.000Z (over 1 year ago)
- Last Synced: 2025-03-06T02:38:20.079Z (11 months ago)
- Topics: hacktoberfest, jsonresume, jsonresume-theme, resume, resume-template
- Language: LiveScript
- Homepage: https://www.npmjs.com/package/jsonresume-theme-relaxed
- Size: 297 KB
- Stars: 10
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# jsonresume-theme-relaxed
A [JSON Resume][] theme optimised for PDF output.
[JSON Resume]: https://jsonresume.org/
## Installation
```bash
git clone https://github.com/ObserverOfTime/jsonresume-theme-relaxed
cd jsonresume-theme-relaxed && npm install
```
## Create your resume
Create a `resume.json` file according to the [schema][],
build it [online][resume-builder], or export it from [LinkedIn][json-resume-exporter].
Click here for details
| Section | Field | Required | Line breaks (`\n`) | Notes |
|:---:|:---:|:---:|:---:|:---:|
| `basics` | `name` | **Yes** | No | Must be present. |
| | `label` | No | No | |
| | `image` | No | No | |
| | `summary` | No | **Yes** | |
| `basics.location` | `address` | No | No | |
| | `city` | No | No | |
| | `postalCode` | No | No | |
| | `region` | No | No | |
| | `countryCode` | **Yes** | No | |
| `basics.profiles[]` | `url` | No | No | |
| | `network` | **Yes** | No | |
| | `username` | **Yes** | No | |
| `work[]` | `website` | No | No | |
| | `company` | **Yes** | No | |
| | `location` | | | _Unsupported._ |
| | `description` | | | _Unsupported._ |
| | `position` | **Yes** | No | |
| | `summary` | No | **Yes** | |
| | `startDate` | No | No | `YYYY-MM` / `YYYY-MM-DD` |
| | `endDate` | No | No | `YYYY-MM` / `YYYY-MM-DD`
Requires `startDate`. |
| | `highlights[]` | No | No | |
| `education[]` | `url` | No | No | |
| | `area` | **Yes** | No | |
| | `institution` | **Yes** | No | |
| | `studyType` | **Yes** | No | |
| | `startDate` | No | No | `YYYY-MM` / `YYYY-MM-DD` |
| | `endDate` | No | No | `YYYY-MM` / `YYYY-MM-DD`
Requires `startDate`. |
| | `score` | No | No | |
| | `courses[]` | No | No | |
| | `url` | No | No | |
| | `summary` | **Yes** | No | Should be the event name. |
| | `organization` | **Yes** | No | |
| | `position` | **Yes** | No | |
| | `startDate` | No | No | `YYYY-MM-DD` |
| | `endDate` | No | No | `YYYY-MM-DD`
Requires `startDate`. |
| | `highlights[]` | No | No | |
| `projects[]` | `url` | No | No | |
| | `name` | **Yes** | No | |
| | `type` | | | _Unsupported._ |
| | `roles[]` | No | No | |
| | `entity` | No | No | Requires `roles[]`. |
| | `description` | No | **Yes** | |
| | `startDate` | No | No | `YYYY-MM-DD` |
| | `endDate` | No | No | `YYYY-MM-DD`
Requires `startDate`. |
| | `highlights[]` | No | No | |
| | `keywords[]` | No | No | |
| `publications[]` | `website` | No | No | |
| | `name` | **Yes** | No | |
| | `publisher` | **Yes** | No | |
| | `summary` | No | **Yes** | |
| | `releaseDate` | **Yes** | No | `YYYY-MM` / `YYYY-MM-DD` |
| | `url` | No | No | |
| | `name` | **Yes** | No | |
| | `issuer` | **Yes** | No | |
| | `date` | **Yes** | No | `YYYY-MM` / `YYYY-MM-DD` |
| `skills[]` | `name` | **Yes** | No | |
| | `level` | **Yes** | No | "master" / "advanced" /
"intermediate" / "beginner" |
| | `keywords[]` | No | No | |
| `languages[]` | `language` | **Yes** | No | |
| | `fluency` | **Yes** | **Yes** | |
| `awards[]` | `title` | **Yes** | No | |
| | `awarder` | **Yes** | No | |
| | `summary` | No | **Yes** | |
| | `date` | **No** | No | `YYYY-MM` / `YYYY-MM-DD` |
| `interests[]` | `name` | **Yes** | No | |
| | `keywords[]` | No | No | |
| `references[]` | `name` | **Yes** | No | |
| | `reference` | **Yes** | **Yes** | |
| `meta` | `canonical` | No | no | |
| | `lastModified` | No | No | |
| | `version` | No | No | |
| | `x-lang` | No | No | Language (default: "en").
_Non-standard._ |
| | `x-size` | No | No | Font size (default: "10pt").
_Non-standard._ |
_All sections (except for `basics`) are optional._
_Fields are only required if the section is present._
Supported languages:
- English ("en")
- Greek ("el")
- German ("de")
- French ("fr")
[schema]: https://jsonresume.org/schema/
[resume-builder]: https://resume-builder.js.org/en/build
[json-resume-exporter]: https://chrome.google.com/webstore/detail/json-resume-exporter/caobgmmcpklomkcckaenhjlokpmfbdec
## Export to PDF
```bash
npm run build -- resume.pdf
```
## Sample
## Credits
The theme was made using [HTMLS][] & [Stylus][],
with icons from [Heroicons][] & [Simple Icons][]
and the [Lato][] font.
[HTMLS]: https://github.com/Daiz/htmls
[Stylus]: https://stylus-lang.com/
[Heroicons]: https://heroicons.dev/
[Simple Icons]: https://simpleicons.org/
[Lato]: https://www.latofonts.com/
## License
> This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.