ea42122dd5
Introduce placeholder partials for canonical Word 2003 XML document parts. |
||
---|---|---|
partials | ||
themes | ||
.gitattributes | ||
.gitignore | ||
LICENSE.md | ||
package.json | ||
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.
- underscore: An unstyled barebones theme.
- hello-world: A simple-as-possible example theme.
- New themes weekly.
Use
-
Install HackMyResume or a similar tool.
-
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.
- Fork, branch, and clone this repository.
- Add or edit a theme or make other changes.
- Submit a PR.
License
MIT. See LICENSE.md for details.