docs: document /partials/ folder

This commit is contained in:
hacksalot 2018-02-06 21:06:12 -05:00
parent 20dbf8a13c
commit e7ff6c2554
No known key found for this signature in database
GPG Key ID: 2F343EC247CA4B06
1 changed files with 16 additions and 0 deletions

16
partials/README.md Normal file
View File

@ -0,0 +1,16 @@
/partials/
===
*Global reusable partials for FRESH themes.*
This folder contains generic reusable templates for FRESH resume assembly. These
are provided on a per-format basis (one set of partials for DOC, one set of
partials for HTML, etc.) and can be invoked from any theme that needs them.
- [/doc](/doc): Partials for MS Word (\*.doc) formats.
- [/html](/html): Partials for HTML (\*.html) formats.
- [/md](/md): Partials for Markdown (\*.md) formats.
- [/txt](/txt): Partials for text (\*.txt) formats.
Note that not every FRESH theme uses partials, and not every FRESH theme that
uses partials will use these predefined partials. FRESH themes may define their
own custom partials or forgo the idea of using partials altogether.