JuanCanham
/
fresh-themes
mirror of https://github.com/JuanCanham/fresh-themes.git
1
0
Fork 0
Code Issues Releases Wiki Activity
174 Commits 4 Branches 31 Tags 11 MiB
TeX 49.6%
HTML 44.5%
CSS 5.5%
JavaScript 0.4%
Go to file
hacksalot 06e458eab7 Remove unused files. 2016-01-06 10:30:08 -05:00
partials Continue refactoring. 2016-01-06 10:23:40 -05:00
themes Remove unused files. 2016-01-06 10:30:08 -05:00
.gitattributes Initial commit. 2015-10-06 14:20:47 -04:00
.gitignore Reorganize themes. 2015-10-26 04:57:06 -04:00
LICENSE.md Update license info. 2016-01-05 00:24:27 -05:00
README.md Update README. 2016-01-06 05:44:05 -05:00
package.json Introduce global theme partials. 2016-01-06 03:51:13 -05:00

README.md

fresh-themes

Stylized templates for your résumé and/or CV, compatible with FRESH and (through conversion) JSON Resume formats.

  • positive: A visually dense/compact theme.
  • modern: A middle of the road theme with a modern look 'n feel.
  • compact: A visually dense/compact theme.
  • awesome: A technical resume theme based on Awesome-CV.
  • minimist: An unstyled barebones theme.
  • hello-world: A simple-as-possible example theme.
  • New themes weekly.

Use

  1. Install HackMyResume or a similar tool.

  2. Create a FRESH or JRS résumé.

  3. Run hackmyresume build <your-resume.json> to <final-resume>.all -t <theme-name> to generate all formats for a particular theme. For example:

    hackmyresume BUILD resume.json TO out/resume.all -t positive

Install

The fresh-themes repo is automatically installed when you install HackMyResume. For development or testing purposes, you can install the standalone version via NPM:

[sudo] npm install fresh-themes [--save]

...or fork and clone it from GitHub as usual.

How It Works

FRESH themes are powered by the same templates you're familiar with from Jekyll, Handlebars, MS Word, or your server-side web language of choice. You create a FRESH theme the same way you would any other template: by intermixing markup (HTML, XML, plain text, whatever) with special tags or placeholders:

<h3>{{ job.title }}</h3>
<p>{{ job.summary }}</p>

Run it through a tool, and you get finished markup suitable for display or saving as a document:

<h3>Ninja</h3>
<p>Performed covert ops in feudal Japan.</p>

The only difference between a FRESH theme and your Jekyll blog or MS Word template is that FRESH themes are:

  • Multiformat. Each FRESH theme can declare multiple formats: HTML, Word, PDF, Markdown, or other future formats.
  • Markdown-friendly. All FRESH themes support inline Markdown/HTML formatting.
  • Inheritable. FRESH themes can inherit or "borrow" formats from other themes.
  • Agnostic. FRESH themes don't mandate that you use a particular templating engine or style: you can use Handlebars, Underscore, or other engines in the future.

If you can do {{ r.name }} or {% highlight html %} in a template file you can work with FRESH themes.

Structure

FRESH themes are structured to allow for flexible generation of documents in multiple formats. Each theme lives in a separate folder and consists of:

  • A JSON description file.
  • One or more template files in Handlebars or Underscore format.
  • Any necessary support files (CSS, LaTeX partials, etc.).
  • A dedicated README.

Within its containing folder, a theme can have an arbitrary structure provided you either a) follow a standard naming convention or b) specify your theme files in your theme's JSON file.

Contribute

Contributions are welcome.

  1. Fork, branch, and clone this repository.
  2. Add or edit a theme or make other changes.
  3. Submit a PR.

License

MIT. See LICENSE.md for details.