#Awesome-CV-Markdown

Awesome CV Markdown is a program developed for the Compilers curricular unit. It receives a Markdown file with your Curriculum Vitae in it and returns it written in Latex and HTML. It is easy to customize your own CV, especially since it is really written in a clean markdown. To use it all you have to do is import this project to an IDE (for example, IntelliJ) run it and follow the steps given.

Table of Contents

1. How to Use
2. Preview
3. Markdown Used
4. Characters not suported
5. Notes

##How to Use

It is easy to use just follow this steps:

1. insert the markdown path file
2. Select what you want to appear in your CV
3. Press run
4. Confirm the Latex and HTML file, present in ./resources/generated/yourCVName/

##Preview Here is an example of the PDF, LaTex and HTML generated for this md File

##Markdown Used Here’s an overview of our Markdown syntax.

The CV is divided in header and blocks that contain sub-blocks of information. To define any part of your CV you can use:

Headers:
# For something very important -> Start of a Block
## For something Important -> Start of a subBlock

Blocks can contain TEXT, LISTS or TABLES. If you don't want to type same information you can use variables defined previously before header and use them anywhere in you blocks.

Lists:
* List header
> List item

Define a variable:
/variablesName = definition 

Bold text:
**Word**

Italic text:
*Word*

Tables:
Table header:

FisrtHeader ^ SecondHeader ^ ThirdHeader

Table item:

FisrtItem | SecondItem | ThirdItem

All List and Table items can contain a date, a place, or a classification in stars. We call this icons, the program supports all icons from fontawsome.

Icon:
{iconName}

Classification in stars:
{stars numbofStars/totalNumber}

Examples of special icons suported:
{mobile}
{linkedin}
{email}
{github}

Every block is divided by a spliter.

Block spliter:
===

##Characters not suported Like in every other language some characters are not supported. All you have to do is add an escape. For example, / is not suported but / is.

##Notes All blocks must end with ==='\n'.