Awesome-CV-Markdown

KO | EN

gitlite — search

#hacktoberfest #react #ai #go #golang #rust #linux #macos #nodejs #java #awesome #vue #awesome-list #pytorch

Awesome-CV-Markdown

(★ 10)

A markdown version of awesome-cv (https://github.com/posquit0/Awesome-CV).

Awesome-CV-Markdown Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#Awesome-CV-Markdown[![Example](https://img.shields.io/badge/example-pdf-green.svg)](https://github.com/dimamo5/Awesome-CV-Markdown/blob/master/resources/generated/cv.pdf)

[Awesome CV Markdown](https://github.com/dimamo5/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](#HowtoUse)
2. [Preview](#Preview)
3. [Markdown Used](#MarkdownUsed)
4. [Characters not suported](#Charactersnotsuported)
5. [Notes](#Notes)

##<a name="HowtoUse"></a>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/

##<a name="Preview">Preview
Here is an example of the [PDF](https://github.com/dimamo5/Awesome-CV-Markdown/blob/master/resources/generated/cv.pdf), [LaTex](https://github.com/dimamo5/Awesome-CV-Markdown/blob/master/resources/generated/cv.tex) and [HTML](https://github.com/dimamo5/Awesome-CV-Markdown/blob/master/resources/generated/cv.html) generated for this [md File](https://github.com/dimamo5/Awesome-CV-Markdown/blob/master/resources/mdFiles/cv.md)

##<a name="MarkdownUsed"></a>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:

```Markdown 
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.

```Markdown 
Lists:
* List header
> List item
```

```Markdown 
Define a variable:
/variablesName = definition 
```

```Markdown 
Bold text:
**Word**
```

```Markdown 
Italic text:
*Word*
```

```Markdown 
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](http://fontawesome.io/?utm_source=hackernewsletter).

```Markdown 
Icon:
{iconName}

Classification in stars:
{stars numbofStars/totalNumber}

Examples of special icons suported:
{mobile}
{linkedin}
{email}
{github}
```
Every block is divided by a spliter.

```Markdown 
Block spliter:
===
```
##<a name="Charactersnotsuported">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.

##<a name="Notes">Notes
All blocks must end with ==='\n'.

Awesome-CV-Markdown

Awesome-CV-Markdown Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Awesome-CV-Markdown

Awesome-CV-Markdown Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README