JuanCanham
/
fresh-themes
mirror of https://github.com/JuanCanham/fresh-themes.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.

This commit is contained in:
devlinjd 2015-12-09 09:09:20 -05:00
parent c52840918f
commit 676e003c7e
1 changed files with 30 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,27 +1,44 @@
fluent-themes
=============
Resume themes for [FluentCV][1] and [FluentCV command line][2].
Stylized templates for your résumé and/or CV, compatible with [FRESH][f] and
[JSON Resume][jrs] formats.
- `awesome`: A technical resume theme based on Awesome-CV.
- `minimist`: A no-frills theme.
- `modern`: A middle of the road theme with a modern look 'n feel.
- `hello-world`: A simple-as-possible example theme.
- `compact`: A compact theme.
- New themes forthcoming.
- New themes weekly.
## How It Works
## Install
Each theme lives in a folder, e.g., `themes/informatic` or `themes/modern`. The folder contains individual template files assembled by the theme author. Each template can be used to generate a single type of output file such as HTML, Word, or PDF. Template files are named according to this scheme...
You don't need to install this repository to use the themes; just install
[FluentCV Desktop][1] or [Command Line][2]. Otherwise you can install the latest official standalone version of the theme repository over NPM...
[ OuputFormat ].[ InputFormat ]
`[sudo] npm install fluent-themes --save`
...where `[OuputFormat]` and `[InputFormat]` are both one of `html`, `pdf`, `md`, `txt`, `doc`, or `xml`. For example:
...or fork and clone it as usual.
- `html.html` = An HTML template used to generate an HTML document.
- `doc.xml` = An XML template used to generate an MS Word document.
- `pdf.html` = An HTML template used to generate a PDF document.
- `md.txt` = A text template used to generate a Markdown document.
## Structure
This scheme ensures that theme template files have the "correct" file extension when the theme author is working with them in an editor—if your source data is XML then the template file will have an `.xml` extension regardless of whether you're ultimately generating an HTML page or a PDF document *from* that XML. It also provides a declarative mapping between a given input format (say, XML) and a given output file type (say, a Word doc or spreadsheet).
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. If you can do `{{ r.name }}` in a template file you
can work with FRESH themes.
## 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
@ -30,3 +47,5 @@ MIT. See [LICENSE.md][1] for details.
[1]: http://fluentcv.com
[2]: https://github.com/fluentdesk/fluentcv
[3]: ../LICENSE.md
[f]: https://github.com/fluentdesk/FRESCA
[jrs]: http://jsonresume.org