From 2a322a9b12c925eb355807e5f1e33e0513e69a96 Mon Sep 17 00:00:00 2001 From: Diego Zamboni Date: Sat, 7 Dec 2019 21:29:22 +0100 Subject: [PATCH] Updated documentation. --- doc/content/post/latex_export.md | 25 ++++++++++++++++++++++++- readme.org | 21 ++++++++++++++++++++- 2 files changed, 44 insertions(+), 2 deletions(-) diff --git a/doc/content/post/latex_export.md b/doc/content/post/latex_export.md index 57e621b..d27c14d 100644 --- a/doc/content/post/latex_export.md +++ b/doc/content/post/latex_export.md @@ -97,7 +97,30 @@ When exporting you can call the following function to get the latex file. ## Using AwesomeCV {#using-awesomecv} [AwesomeCV](https://github.com/posquit0/Awesome-CV) is another LaTeX template for producing nice-looking -CVs. AwesomeCV supports a few additional types of environment types in +CVs. In addition to the regular document attributes, the following are supported: + +
+
+ +| Field | Description | +|------------------|------------------------------------------------------------| +| PHOTOSTYLE | Style of photo to use. Values include | +| | circle/rectangle,edge/noedge,left/right | +| CVCOLOR | Color of highlights. | +| STACKOVERFLOW | Stack overflow, must be specified as `ID username` | +| FONTDIR | Directory where the fonts can be found, defaults | +| | to `fonts/` (as in the standard AwesomeCV) | +| CVHIGHLIGHTS | Whether to colorize highlights. Defaults to true | +| QUOTE | Optional quote to include at the top of the CV | +| FIRSTNAME | Your first name. Must be specified (in addition to AUTHOR) | +| LASTNAME | Your last name. Must be specified. | +| CVFOOTER\_LEFT | Text to include in the left footer. | +| CVFOOTER\_MIDDLE | Text to include in the middle footer. | +| CVFOOTER\_RIGHT | Text to include in the right footer. | + +
+ +AwesomeCV supports a few additional types of environment types in `CV_ENV`, including `cvemployer`, `cvskills`, `cvhonors` and `cvschool`. Some of these support additional property fields: diff --git a/readme.org b/readme.org index f7d558c..acaae91 100644 --- a/readme.org +++ b/readme.org @@ -216,7 +216,26 @@ When exporting you can call the following function to get the latex file. ** Using AwesomeCV [[https://github.com/posquit0/Awesome-CV][AwesomeCV]] is another LaTeX template for producing nice-looking -CVs. AwesomeCV supports a few additional types of environment types in +CVs. In addition to the regular document attributes, the following are supported: + +#+attr_html: :class table table-striped +| Field | Description | +|-----------------+------------------------------------------------------------| +| PHOTOSTYLE | Style of photo to use. Values include | +| | circle/rectangle,edge/noedge,left/right | +| CVCOLOR | Color of highlights. | +| STACKOVERFLOW | Stack overflow, must be specified as =ID username= | +| FONTDIR | Directory where the fonts can be found, defaults | +| | to =fonts/= (as in the standard AwesomeCV) | +| CVHIGHLIGHTS | Whether to colorize highlights. Defaults to true | +| QUOTE | Optional quote to include at the top of the CV | +| FIRSTNAME | Your first name. Must be specified (in addition to AUTHOR) | +| LASTNAME | Your last name. Must be specified. | +| CVFOOTER_LEFT | Text to include in the left footer. | +| CVFOOTER_MIDDLE | Text to include in the middle footer. | +| CVFOOTER_RIGHT | Text to include in the right footer. | + +AwesomeCV supports a few additional types of environment types in =CV_ENV=, including =cvemployer=, =cvskills=, =cvhonors= and =cvschool=. Some of these support additional property fields: