Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/anthonyjdella/customized-jsonresume-theme-mocha-responsive

🍴I tweaked the 'Mocha Responsive' theme for JSON Resume
https://github.com/anthonyjdella/customized-jsonresume-theme-mocha-responsive

json resume

Last synced: 1 day ago
JSON representation

🍴I tweaked the 'Mocha Responsive' theme for JSON Resume

Host: GitHub
URL: https://github.com/anthonyjdella/customized-jsonresume-theme-mocha-responsive
Owner: anthonyjdella
Created: 2021-10-22T02:13:25.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2023-02-12T07:16:46.000Z (almost 2 years ago)
Last Synced: 2024-05-01T17:27:00.018Z (9 months ago)
Topics: json, resume
Language: HTML
Homepage: https://resume.anthonydellavecchia.com/anthonyjdella?customTheme=mocha-responsive
Size: 1.1 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Customized JSON Resume Theme: Mocha Responsive
🖼️ This is a tweaked version of the [Mocha Responsive theme](https://github.com/karlitos/jsonresume-theme-mocha-responsive). Tweaked to fit my design preferences. Published on NPM and GitHub Registry.

## Notable Changes

* 2 Page version in PDF/printable mode
* Added sections for speaking and articles
* Style changes

## Prerequisites

To build and start the local server, it needs to use the cli command, which is custom cli I tweaked.

`npm i @anthonyjdella/customized-resume-cli`

## How to Start

`npm run start`

## How to Change

* `resume.hbs` is the order of the resume.
* `views/components/` are the html files for each section
* `styles/main.css` is the styling
* To make changes to the PDF/printable version, make changes in the `@print` section of `styles/main.css`
* Change version number in `package.json`
* Deploy the changes via `npm publish --access public`
* To see changes from `resume.anthonydellavecchia.com` you need to go to the [registry project](https://github.com/anthonyjdella/customized-registry-functions), then cd into `functions`, run `npm i` and `npm update`, then `firebase deploy`.

## Usage
* `npm run start` to start local server.

## Content
* `resume.hbs` template for resume.
* `views/components/` main content which is injected into template (resume.hbs).
* `views/partials/` secondary content which is injected into template (resume.hbs).
* `index.js` helper functions & render function which renders the resuem.
* `public/index.html` generated HTML after running `npm run build`.
* `styles/main.css` style for the site.

Click to expand README.md of the source repository!

# Theme mocha responsive

Dark, stylish theme strongly based on the [jsonresume-theme-caffeine](https://github.com/kelyvin/jsonresume-theme-caffeine) done by [Kelvin Nguyen](https://github.com/kelyvin). It's a theme for the [JSON Resume](http://jsonresume.org/) project and can by used with the [HackMyResume](https://github.com/hacksalot/HackMyResume) to generate nice resumes in many supported formats.

![Screenshot](screenshot.png "Preview of the resume")

The theme uses [handlebars](https://handlebarsjs.com/) templating engine for rendering and utilizes [Font Awesome](https://fontawesome.com/). The generated HTML should have very good browser support by explicitly relying on older styling techniques. Although the theme is dark, there is separate tweaked styling for printing, with dark fonts on white background.

![Print-preview](print-preview.png "Preview of the printed output")

The theme can be used with tools supporting asynchronous theme rendering. It converts local or remote profile images to Base64 format, including them directly in the markup, so the generated HTML file can be used standalone. For certain sections (_summary, work, education, volunteer ..._) Markdown markup is supported. __By default__, the image processing and Markdown support are disabled and can be enabled by setting RENDER_MARKDOWN or PROCESS_IMAGE environment variables to _true_.

For usage and issues associated with HackMyResume see the next section.

## Using the theme

The theme supports the [HackMyResume](https://github.com/hacksalot/HackMyResume) tool and shall be fully compatible with [resume-cli](https://github.com/jsonresume/resume-cli). The theme was specifically developed for my own toolkit [KissMyResume](https://github.com/karlitos/KissMyResume) which can utilize the __async rendering__ and __markdown support__.

Install the theme from npm
```bash
npm install jsonresume-theme-mocha-responsive
```
### Using with KissMyResume

The KissMyResume tool will automatically utilize async theme rendering and has support for Markdown markup and conversion of local and remote images to Base64. Set RENDER_MARKDOWN or PROCESS_IMAGE environment variables to _true_ to enable those features.

```bash
RENDER_MARKDOWN=true PROCESS_IMAGE=true kissmyresume build path-to-resume.json --theme jsonresume-theme-mocha-responsive/
```

You can use the `serve` command for live in-Browser preview with hot-reloading on resume changes.

```bash
RENDER_MARKDOWN=true PROCESS_IMAGE=true kissmyresume serve path-to-resume.json --theme jsonresume-theme-mocha-responsive/
```

### Using with HackMyresume

The HackMyResume tool does not support async theme rendering, nor supports it helper transforming images to Base64 or converting markdown to HTML. Those helpers are disabled by default and yo should not use them with HackMyResume.

Due to the [current bug](https://github.com/hacksalot/HackMyResume/issues/161) in the HackMyResume remote profile pictures are not supported. See [proposed workaround](https://github.com/hacksalot/HackMyResume/issues/161#issuecomment-441393008) in the comments.

```bash
hackmyresume build path-to-resume.json --theme node_modules/jsonresume-theme-mocha-responsive/
```

### Using with [resume-html](https://github.com/hankchiutw/resume-html)

You can render your resume in HTML (and print it to PDF) with the resume-html tool.

Set RENDER_MARKDOWN or PROCESS_IMAGE environment variables to _true_ to enable Markdown support and conversion of local and remote images to Base64.

```bash
RENDER_MARKDOWN=true PROCESS_IMAGE=true path/to/resume-html/index.js outputFileName.html --resume path/to/resume.json --theme path/to/jsonresume-theme-mocha-responsive/
```

## License

Available under [the MIT license](http://mths.be/mit).