jsonresume-theme-kindrobot/README.md

58 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2022-07-27 16:34:10 +00:00
# jsonresume-theme-kindrobot
2014-07-25 17:48:10 +00:00
2022-07-27 16:34:10 +00:00
See this theme in action at
[resume.kindrobot.ca/resume.html](https://resume.kindrobot.ca/resume.html).
2014-07-28 21:29:31 +00:00
2022-07-27 16:34:10 +00:00
This theme includes:
- icons for headings, languages, and profiles
- print aware styling
- support for `basics.pronouns` (non-standard field)
- support for `work[].keywords` (non-standard field)
2014-07-31 11:15:41 +00:00
2022-07-27 16:34:10 +00:00
This is the boilerplate theme for [JSON Resume](http://jsonresume.org/).
2014-07-31 11:15:41 +00:00
2022-07-27 16:34:10 +00:00
## Getting started
2014-07-31 11:15:41 +00:00
2022-07-27 16:34:10 +00:00
### Prerequisite
2014-07-28 21:34:34 +00:00
2022-07-27 16:34:10 +00:00
Install nodejs and npm through your package manager or by following instructions
[here](https://nodejs.dev/learn/how-to-install-nodejs).
2014-07-31 11:15:41 +00:00
2022-07-27 16:34:10 +00:00
### Setting up your resume.json
2014-07-31 11:15:41 +00:00
```bash
2022-07-27 16:34:10 +00:00
mkdir resume
cd resume
npm install resume-client --save
npx resume init
2014-07-31 11:15:41 +00:00
```
2022-07-27 16:34:10 +00:00
### Install jsonresume-theme-kindrobot
2014-07-31 11:15:41 +00:00
2022-07-27 16:34:10 +00:00
```bash
npm install jsonresume-theme-kindrobot --save
2014-07-31 11:15:41 +00:00
```
2022-07-27 16:34:10 +00:00
### Generate your resume
2014-07-31 11:15:41 +00:00
2022-07-27 16:34:10 +00:00
```bash
2022-07-27 16:41:34 +00:00
npx resume serve --theme jsonresume-theme-kindrobot
2014-07-31 11:15:41 +00:00
```
2022-07-27 16:34:10 +00:00
## Advanced setup
2022-07-27 16:34:10 +00:00
For a more advanced setup that include deploying the resume to static site
hosting, checkout
[tildegit.org/kindrobot/resume](https://tildegit.org/kindrobot/resume).
2022-07-27 16:34:10 +00:00
## Pull requests welcome
2022-07-27 16:34:10 +00:00
So far this theme has primarily been tailored to my personal resume. There's a
good chance it won't look perfect out-of-the box with someone else's
`resume.json`. If you use this theme and make improvements, please open a PR or
e-mail your patch to kindrobot@tilde.team.
2014-07-28 21:34:34 +00:00
## License
Available under [the MIT license](http://mths.be/mit).