Skip to content

Latest commit

 

History

History
executable file
·
59 lines (36 loc) · 3.67 KB

README.md

File metadata and controls

executable file
·
59 lines (36 loc) · 3.67 KB
Raw

Theme mocha responsive

Dark, stylish theme strongly based on the jsonresume-theme-caffeine done by Kelvin Nguyen. It's a theme for the JSON Resume project and can by used with the HackMyResume to generate nice resumes in many supported formats.

Screenshot

The theme uses handlebars templating engine for rendering and utilizes Font Awesome. 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

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 tool and shall be fully compatible with resume-cli. The theme was specifically developed for my own toolkit KissMyResume which can utilize the async rendering and markdown support.

Install the theme from npm

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.

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.

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 in the HackMyResume remote profile pictures are not supported. See proposed workaround in the comments.

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

Using with 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.

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.