dduportal/md2cv repository overview

⁠My Curriculum Vitae

This repository contains my curriculum vitae.

No more, no less.

⁠Why ?

As a software engineer, I wanted my CV to follow my professional practices :

• Source text based to easily use SCMs, merging, diffing, history
• Publicly available, shareable, editable
• HTML W3C compliant but also PDF format to ease reading

I also wanted to (re)-learn some basics of the front (and back)⁠ end development, using a task runner, livereload, and other facilities.

Ruby is also used because, it is just fun to combine heterogenous tools.

⁠What ?

• Content of the CV is in YAML format⁠.
• HTML and PDF rendered versions can also be found here :
  • HTML version⁠
  • PDF version (not available yet)
• Rendering from YAML to HTML is done with HAML engine⁠
• This is mainly a fork of hoogeveen/cv⁠, thanks for this great work !

⁠How ?

⁠Easy method : Docker⁠ and Compose⁠

Docker⁠ is used to make the packaging easy and portable Compose⁠ will take care of mounting files, forwarding ports, etc.

Ensure you have Docker⁠ and Compose⁠ clients configured to reach a working Docker Engine

Then, just run to launch the Gulp⁠ process :

$ docker-compose up

Open you browser to the page, using your Docker Engine IP :

http://<YOUR DOCKER ENGINE IP>:4000

⁠Not-so-easy method : Local Gulp and local Bundler

If you know your way with Gulp⁠, NPM⁠, and Bundler⁠ or just do not want to use Docker⁠, you should follow those instructions in the right order :

1. Install NPM⁠. We use it to manage dependencies.

2. Then you need a Ruby Bundler installation⁠ to manage dependencies of Ruby Gem with this command :

   # With Ruby and Bundler installed
   $ bundle install
   ...
   

   Copy

3. Then you can bootstrap dependencies with NPM⁠ :

   # Will install all the dev. modules locally
   $ npm install
   ...
   

   Copy

4. Gulp⁠ is used as workflow engine by running tasks :

   $ gulp
   # It will run the default task that renders, serves pages
   # with live-reload enabled
   

   Copy

5. Open your browser to http://localhost:4000⁠

⁠Deploying

The folder ./src/export :

• Is not stored inside git (cf .gitignore)
• Is both generated and served by the Gulp⁠ workflow

If you want to deploy the content of this folder to another directory, just mount it with docker-compose⁠ and provide and environment variable.

For example, using docker-compose extending feature⁠ :

1. Create a file name docker-compose.override.yml at the repository root (note that this file will not be git-tracked for security reasons) :

gulp-server:
    volumes:
      - ~/some/folder:/folder/to/deploy
    environment:
      - DEPLOY_DIR=/folder/to/deploy

1. Then, just call the gulp deploytarget :

$ docker-compose run gulp-server deploy

1. OR run gulp deployif you are in local mode:

$ DEPLOY_DIR=~/some/folder gulp deploy

⁠Licensing

This repository is provided on the ISC license⁠.

You will find the License here⁠.

It means you can use the content only if you make it appear with the same license.