Skip to content

engelhardtnick/jsonresume-theme-hexagon

 
 

Repository files navigation

Hexagon npm

💥 Another JSON Resume theme...

The difference this time, is that now it's AWESOME! 💫

This is my little contribution to the awesome JSON Resume project and community. As they say "For developers, by developers."

Made with ❤️ using just the best tools on the net !!! 😜


Theme screenshot

Features

  • Keep your resume offline if you want to: the theme is self-contained.
  • Great Font Awesome icons.
  • Gorgeous Open Sans web font.
  • Optimized for print and screen readers.
  • Contains Schema.org markup to make the most of your content.
  • All fields are optional, pick what you need!

Notes: some fields are mapped to achieve some other features that needed support on this theme:

  • highlights under work section is used to describe the code stack, e.g. React, express.js, etc...

  • skills section, level is a number from 1 to 5 as a string, e.g. for a skill on React with level 3 you should write:

    ...
    skills: [{
      "name": "React",
      "level": "3",
      "keywords": []
    },
    ...
    ]
    ...

Usage

Local editable setup (recommended)

To make local changes or experiment with the theme:

# Clone your fork
git clone https://github.com/engelhardtnick/jsonresume-theme-hexagon.git
cd jsonresume-theme-hexagon

Install dependencies npm install

Link the package globally so it behaves like an installed theme npm link

A helper script is provided in /render-locally/generate-resume.js

Make sure your resume.json file is in the root of the repository.

Run the script:

node render-locally/generate-resume.js

This will generate a resume.html file in the root directory using your local version of the theme.

Open resume.html in your browser to preview, or print to PDF for export.

Adding skills and skill groups

All skills that are displayed on the left side of the resume must be registered in ./mapper.json. Simply add your additional skills to an existing group or add another group altogether.

Contributing

Install the project with:

git clone https://github.com/nricardo/jsonresume-theme-hexagon.git
cd jsonresume-theme-hexagon
npm install
./.githooks/deploy
# To actively work on the theme.
npm run start

To run the tests locally:

# To create a reference resume export.
npm run test
cp test/resume.html test/old-resume.html
# To compare the result of your changes against the reference.
npm run test
diff -u test/old-resume.html test/resume.html

To release a new version:

npm version minor -m "Release %s"
git push origin master
git push --tags
npm publish

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • HTML 88.8%
  • JavaScript 6.9%
  • CSS 2.5%
  • Handlebars 1.8%