mirror of
https://github.com/JuanCanham/fresh-themes.git
synced 2024-11-25 09:30:10 +00:00
Update README.
This commit is contained in:
parent
50017c43e9
commit
b9a7848cf1
66
README.md
66
README.md
@ -1,8 +1,8 @@
|
|||||||
fresh-themes
|
fresh-themes
|
||||||
============
|
============
|
||||||
|
|
||||||
Stylized templates for your résumé and/or CV, compatible with [FRESH][f] and
|
*Stylized templates for your résumé and/or CV, compatible with [FRESH][f] and
|
||||||
[JSON Resume][jrs] formats.
|
(through conversion) [JSON Resume][jrs] formats.*
|
||||||
|
|
||||||
- [positive][t-positive]: A visually dense/compact theme.
|
- [positive][t-positive]: A visually dense/compact theme.
|
||||||
- [modern][t-modern]: A middle of the road theme with a modern look 'n feel.
|
- [modern][t-modern]: A middle of the road theme with a modern look 'n feel.
|
||||||
@ -12,15 +12,63 @@ Stylized templates for your résumé and/or CV, compatible with [FRESH][f] and
|
|||||||
- [hello-world][t-hello]: A simple-as-possible example theme.
|
- [hello-world][t-hello]: A simple-as-possible example theme.
|
||||||
- New themes weekly.
|
- New themes weekly.
|
||||||
|
|
||||||
|
## Use
|
||||||
|
|
||||||
|
1. Install [HackMyResume][hmr] or a similar tool.
|
||||||
|
|
||||||
|
2. Create a [FRESH][f] or [JRS][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:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hackmyresume BUILD resume.json TO out/resume.all -t positive
|
||||||
|
```
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
You don't need to install this repository to use the themes; just install
|
The **fresh-themes** repo is automatically installed when you install
|
||||||
[FluentCV Desktop][1] or [Command Line][2]. Otherwise you can install the latest
|
HackMyResume. For development or testing purposes, you can install the
|
||||||
official standalone version of the theme repository over NPM...
|
standalone version via NPM:
|
||||||
|
|
||||||
`[sudo] npm install fresh-themes --save`
|
`[sudo] npm install fresh-themes [--save]`
|
||||||
|
|
||||||
...or fork and clone it as usual.
|
...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:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<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:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<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
|
## Structure
|
||||||
|
|
||||||
@ -34,8 +82,7 @@ multiple formats. Each theme lives in a separate folder and consists of:
|
|||||||
|
|
||||||
Within its containing folder, a theme can have an arbitrary structure provided
|
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
|
you either a) follow a standard naming convention or b) specify your theme files
|
||||||
in your theme's JSON file. If you can do `{{ r.name }}` in a template file you
|
in your theme's JSON file.
|
||||||
can work with FRESH themes.
|
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
@ -61,3 +108,4 @@ MIT. See [LICENSE.md][1] for details.
|
|||||||
[t-hello]: https://github.com/fluentdesk/fresh-themes/tree/master/themes/hello-world
|
[t-hello]: https://github.com/fluentdesk/fresh-themes/tree/master/themes/hello-world
|
||||||
[t-compact]: https://github.com/fluentdesk/fresh-themes/tree/master/themes/compact
|
[t-compact]: https://github.com/fluentdesk/fresh-themes/tree/master/themes/compact
|
||||||
[t-positive]: https://github.com/fluentdesk/fresh-themes/tree/master/themes/positive
|
[t-positive]: https://github.com/fluentdesk/fresh-themes/tree/master/themes/positive
|
||||||
|
[hmr]: https://github.com/hacksalot/hackmyresume
|
||||||
|
Loading…
Reference in New Issue
Block a user