https://github.com/XuluWarrior/jsonresume-theme-orbit

Template for JSONResume based on Orbit theme by xriley
https://github.com/XuluWarrior/jsonresume-theme-orbit

Last synced: 10 days ago
JSON representation

Template for JSONResume based on Orbit theme by xriley

• Host: GitHub
• URL: https://github.com/XuluWarrior/jsonresume-theme-orbit
• Owner: XuluWarrior
• Created: 2017-12-01T13:44:21.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T18:54:38.000Z (18 days ago)
• Last Synced: 2024-10-25T19:49:34.833Z (17 days ago)
• Language: CSS
• Size: 553 KB
• Stars: 9
• Watchers: 2
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# JSON Resume Orbit Theme 

[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/XuluWarrior/jsonresume-theme-orbit)

This is a theme for [JSON Resume](http://jsonresume.org/) based on [Orbit design](https://github.com/xriley/Orbit-Theme) by [xriley](https://github.com/xriley).

This version includes more sections than in the original design and also changes a couple of section titles.

For a template that implements the original design see [jsonresume-theme-orbit-original](https://github.com/XuluWarrior/jsonresume-theme-orbit-original).

[![Example resume](https://xuluwarrior.github.io/jsonresume-theme-orbit/resume.jpg)](https://xuluwarrior.github.io/jsonresume-theme-orbit/resume.html)

## Getting started

### Install the command line

Install [resume-cli](https://github.com/jsonresume/resume-cli) to render your resume.

```

sudo npm install -g resume-cli

```

### Serve theme

```

resume serve --theme orbit --resume 

```

You should now see this message:

```

Preview: http://localhost:4000

Press ctrl-c to stop

```

The resume should open in a new tab in your default browser

## Editing template

### Get source from GitHub

```

git clone https://github.com/XuluWarrior/jsonresume-theme-orbit.git

cd jsonresume-theme-orbit

```

### Serve theme

```

resume serve

```

This will use the local version of the theme to render the resume.json

If there is a local copy of resume.json this will be used.  Otherwise, it will use the default resume.json from [jsonresume.org](https://jsonresume.org/)

### Change color scheme

This theme comes with 6 color schemes.  To change to an alternative add `themeVariant` to the meta in your resume.json. 

Allowed values: 1 to 6

e.g.

```json

"meta": {

  "theme": "json-resume-orbit",

  "themeVariant": 3

}

```

To revert to the default theme

```

npm run build:styles

```

### Change width of sidebar

If profile details are too wide for the sidebar (as with the v1.0 example resume.json from [jsonresume.org](https://jsonresume.org/)) then edit **less/default/base.less** and change @sidebar-width

e.g.

```

@sidebar-width: 300px;

```

Rebuild styles.css with the appropriate build:styles command.

e.g.

```

npm run build:styles

```

## License

Template design is available under [Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/) attributed to [xriley](https://github.com/xriley)

Source code for generating resume is available under [the MIT license](http://mths.be/mit).