fresh-themes/README.md

33 lines
1.6 KiB
Markdown
Raw Normal View History

2015-10-26 17:36:18 +00:00
fluent-themes
=============
2015-10-28 03:46:36 +00:00
Resume themes for [FluentCV][1] and [FluentCV command line][2].
2015-10-10 22:45:29 +01:00
- `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.
2015-10-28 03:46:36 +00:00
- `compact`: A compact theme.
2015-10-26 17:36:18 +00:00
- New themes forthcoming.
2015-10-10 22:45:29 +01:00
## How It Works
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...
[ OuputFormat ].[ InputFormat ]
...where `[OuputFormat]` and `[InputFormat]` are both one of `html`, `pdf`, `md`, `txt`, `doc`, or `xml`. For example:
- `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.
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).
2015-10-06 19:20:47 +01:00
## License
2015-10-10 22:45:29 +01:00
MIT. See [LICENSE.md][1] for details.
2015-10-06 19:20:47 +01:00
[1]: http://fluentcv.com
2015-10-28 03:46:36 +00:00
[2]: https://github.com/fluentdesk/fluentcv
2015-10-10 22:45:29 +01:00
[3]: ../LICENSE.md