Giter Club home page Giter Club logo

yaml-cv's Introduction

Yet Another YAML CV

Content is YAML / Design is LaTeX

A CV with the design in LaTeX and the data stored in an easy to read/modify YAML file. This repository requires pandoc and pdflatex, which is included with tex live.

  • data.md = CV data in YAML format
  • refs.bib = bib file for publications
  • Makefile = compiles the the CV using pandoc

Modify data.md and refs.bib and then build your CV:

make pdf

This will create the build directory with your compiled CV stored in /build/pdf/cv.pdf.

To clean the build directory

make clean-pdf

Docker

a Docker image with all the necessary software installed is included. This provides a convenient way to use YAML-CV without having to worry about installing all the necessary packages. Here are the steps using Docker.

  1. Clone the GitHub repo:
git clone https://github.com/lgloege/YAML-CV.git
  1. Pull the image (this image is a little hefty at 2.7 GB)
docker pull ghcr.io/lgloege/pandoc-pdflatex:1.0
  1. Run the image and connect the a host volume. If you use the command below make you are starting base directory and not /Docker
docker run -it -v $(pwd):/root ghcr.io/lgloege/pandoc-pdflatex:1.0
  1. Manipulate the data files and build your CV.
make pdf
  1. your CV will be in /build/pdf/cv.pdf. You may not be able to open it from the container. But don't worry, if you have a connected volume then the changes will persist.

Directories

Templates

This directory contains CV templates. This currently only has templates to create a PDF.

  • cv-class.cls = cv class
  • cv-template.tex = cv latex template

Build

Thid directory is created after running make. It contains all the compiled material to create your CV

  • cv-class.cls = CV class copied from /templates
  • refs.bib = bibtex file copied from base directory
  • cv.tex = compiled LaTeX file
  • cv.pdf = PDF created using pdflatex

Notes

Since input is in YAML, you may have to escape some characters, such as :

Currently this only compiles to PDF. additions are include compilation to other formats such as HTML

yaml-cv's People

Contributors

lgloege avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.