{"id":13569011,"url":"https://github.com/barraq/pandoc-moderncv","last_synced_at":"2025-04-04T05:31:08.604Z","repository":{"id":13909325,"uuid":"16608230","full_name":"barraq/pandoc-moderncv","owner":"barraq","description":"Pandoc-ModernCV is a Pandoc fa­cil­i­ties for type­set­ting mod­ern cur­ricu­lums vi­tae. Inspired by the well known Latex ModernCV, it is fairly cus­tomiz­able, al­low­ing you to use predefined themes and to define your own style by changing colors, fonts, etc.","archived":false,"fork":false,"pushed_at":"2022-01-17T18:45:26.000Z","size":2341,"stargazers_count":151,"open_issues_count":11,"forks_count":39,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-07-09T02:55:46.630Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://barraq.github.io/pandoc-moderncv/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/barraq.png","metadata":{"files":{"readme":"README.md","changelog":"changelog","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-02-07T08:11:43.000Z","updated_at":"2024-05-02T18:09:54.000Z","dependencies_parsed_at":"2022-07-10T04:46:36.173Z","dependency_job_id":null,"html_url":"https://github.com/barraq/pandoc-moderncv","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barraq%2Fpandoc-moderncv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barraq%2Fpandoc-moderncv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barraq%2Fpandoc-moderncv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barraq%2Fpandoc-moderncv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/barraq","download_url":"https://codeload.github.com/barraq/pandoc-moderncv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213533301,"owners_count":15601533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T14:00:34.769Z","updated_at":"2024-08-01T14:02:55.374Z","avatar_url":"https://github.com/barraq.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"**Pandoc-ModernCV** provides Pandoc fa­cil­i­ties for type­set­ting modern **cur­ricu­lums vi­tae in markdown**. Inspired by the well known Latex ModernCV, it is fairly cus­tomiz­able, al­low­ing you to use predefined themes and to define your own style by changing colors, fonts, etc.\n\n\u003e With **Pandoc-ModernCV** simply **write your CV in Markdown**, compile it and publish it in a snap!\n\nPandoc-ModernCV currently supports **pdf** and **html5** export formats. The html5 output is responsive and supports rendering for small to large screens.\n\n## Features\n\n\u003e Writing a CV has never been so simple!\n\n- write your CV in Markdown\n- choose between themes\n- customize your style\n- export to HTML5\n    + responsive layout (mobile, tablet, desktop)\n    + print layout\n- export to PDF\n    + A4 format ready\n    + PDF tags (title, author, etc.)\n- publish public \u0026 private CV\n\n## Preview \u0026 Screenshots\n\n### HTML5\n\nLive **html5** preview [here](http://barraq.github.io/pandoc-moderncv/preview/cv.html) \n\n| ![Pandoc-ModernCV large-screen preview ](https://raw.github.com/barraq/pandoc-moderncv/gh-pages/media/images/large-screen.png) |\n| :----: |\n| **Screenshot of the HTML scaffold CV taken for a large screen.**  |\n| See also [medium-screen preview](https://raw.github.com/barraq/pandoc-moderncv/gh-pages/media/images/medium-screen.png) or [small-screen preview](https://raw.github.com/barraq/pandoc-moderncv/gh-pages/media/images/small-screen.png) |\n\n### PDF\n\nLive **pdf** preview [here](http://barraq.github.io/pandoc-moderncv/preview/cv.pdf) \n\n| ![Pandoc-ModernCV PDF export preview ](https://raw.github.com/barraq/pandoc-moderncv/gh-pages/media/images/cv-pdf.png) |\n| :----: |\n| **Screenshot of the PDF scaffold CV.** Notice the QR-Code  |\n\n## Requirements\n\nFor building your CV in html you need:\n- [Compass](http://compass-style.org/) (\u003e= 1.0), \n- [Susy](http://susy.oddbird.net/) (\u003e= 2.1),\n- [RSync](http://rsync.samba.org/),\n- [Pandoc](http://johnmacfarlane.net/pandoc/) (\u003e= 1.13)\n\nFor exporting your CV to pdf you need:\n- wkpdf or wkhtmltopdf:\n    - wkpdf (MacOS X), http://plessl.github.io/wkpdf/\n    - wkhtmltopdf (Linux, Windows), http://wkhtmltopdf.org/\n- exiftool, http://www.sno.phy.queensu.ca/~phil/exiftool/\n\n## Installation\n\nInstall **Compass** and **Susy**:\n    \n    $ gem install compass\n    $ gem install susy\n\nInstall **wkpdf** or **wkhtmltopdf**. If on MacOSX please check Troubleshooting section for installing correctly wkpdf.\n\nInstall **Pandoc** by using your package manager or by using the provided installer http://johnmacfarlane.net/pandoc/installing.html (or using *cabal*)\n\nInstall **exiftool** by using your package manager (use [brew](http://brew.sh/) on Mac)\n\n**rsync** should already be installed... if not, install it using your package manager.\n\nYou are done!\n\n## Getting Started\n\nThe simplest way to get started with *pandoc-moderncv* is to use the provided scaffold. In a terminal just do:\n\n    $ make scaffold\n    $ make html\n\nWhat it does it that it creates a scaffold *cv* located in the /cv directory and builds an html version of it. To open the generated cv just do:\n\n    $ open dist/cv.html\n\nTo export the CV to pdf just do:\n\n    on MacOS X\n    $ make pdf\n\n    on Linux/Windows\n    $ make pdf HTMLTOPDF=wkhtmltopdf\n\nHit the link to [preview the generated pdf](https://github.com/barraq/pandoc-moderncv/raw/gh-pages/preview/cv.pdf) \n\nThere you are!\n\n## Customize\n\n### Metadata\n\nYour CV can be customized with metadata. Metadata are located between two --- separators at the top of the cv.md file and are formated using the YAML format:\n\n    ---\n    lang: en\n    title: Résumé Title\n    firstname: Firstname\n    lastname: Lastname\n    photo: images/picture.png\n    email: contact@yoursite.com\n    mobile: '+1 (234) 567 890'\n    address:\n      city: City \n      country: Country\n    settings:\n      protect-mobile: true\n      protect-email: true\n    ---\n\n    put here your *CV* data\n\nCurrently Pandoc-MordernCV supports the following metadata:\n\n| key                     |  type    | value                          |\n| :---------------------- | :------: | :----------------------------- |\n| lang                    | string   | en                             |\n| title                   | string   | Résumé Title                   |\n| firstname               | string   | Firstname                      |\n| lastname                | string   | Lastname                       |\n| photo                   | url      | path/to/photo.png              |\n| qrcode                  | url      | images/qrcode.png              |\n| contact                 | url      | http://contact.yoursite.com    |\n| homepage                | url      |  http://yoursite.com           |\n| email                   | email    | contact@yoursite.com           |\n| mobile                  | string   | '+1 (234) 567 890'             |\n| phone                   | string   | '+2 (345) 678 901'             |\n| fax                     | string   | '+3 (456) 789 012'             |\n| footer                  | markdown | **custom** *markdown* text     |\n| **address**             | map      |                                |\n|   city                  | string   | City                           |\n|   country               | string   | Country                        |\n| **settings**            | map      |                                |\n| protect-email           | boolean  | true/false (default: false)    |\n| protect-mobile          | boolean  | true/false (default: false)    |\n| protect-phone           | boolean  | true/false (default: false)    |\n| protect-fax             | boolean  | true/false (default: false)    |\n| protect-address         | boolean  | true/false (default: false)    |\n| display-lastupdate      | boolean  | true/false (default: false)    |\n\n### Private \u0026 Public CV\n\nIt is often handy to hide/show specific informations in your CV depending on where it is published/sent. Pandoc-ModernCV supports **public** and **private** cv:\n* when **public**:\n    - protected metadata are removed.\n    - *cv/public.md* is displayed just after the header and before the CV body.\n* when **private**:\n    - protected metadata are displayed.\n    - *cv/private.md* is displayed just after the header and before the CV body.\n\n#### Protecting Metadata\n\nCurrently Pandoc-ModernCV can protect the following metadata:\n* email\n* mobile\n* phone\n* fax\n* address\n\nMetadata can be (un)protected independently as follow:\n\n    ---\n    ...\n    settings:\n      protect-mobile: true # this protect *mobile*\n      protect-email: false # this unprotect *email*\n    ---\n\n\n#### Building Private/Public CV\n\nTo build a public CV just do:\n\n    $ make html public-cv=true\n    or\n    $ make pdf public-cv=true\n\nTo build a private CV just do:\n\n    $ make html private-cv=true\n    or\n    $ make pdf private-cv=true\n\n### Themes\n\nCurrently pandoc-moderncv supports a single theme: classic.\n\n\u003e Feel free to contribute and send me your custom theme!\n\n### Colors, Fonts, Icons\n\nAll themes can be customized through variables defined in *stylesheets/_settings.scss*. Currently the variables are:\n\n    $base-font-size: 18px;\n    $base-line-height: 23px;\n\n    $photo-width: 182px;\n    $qrcode-width: 100px;\n\n    // Size\n    $h1-font-size:      $base-font-size*2;\n    $h1-line-multiple:  2;\n    $h2-font-size:      $base-font-size*1.5;\n    $h2-line-multiple:  1.5;\n    $h3-font-size:      $base-font-size*1.2;\n    $h3-line-multiple:  1;\n\n    // Colors\n    $firstname-color: rgb(0, 0, 0);\n    $familyname-color: rgb(0, 0, 0);\n    $title-color: rgb(89, 89, 89);\n    $address-color: rgb(0, 0, 0);\n    $quote-color: rgb(0, 0, 0);\n    $section-rectangle-color: rgb(191, 191, 191);\n    $section-title-color: rgb(89, 89, 89);\n    $subsection-color: rgb(0, 0, 0);\n    $hint-color: rgb(0, 0, 0);\n\n    // Icons\n    $external-link-icon: $fa-var-external-link;\n    $email-icon: $fa-var-envelope-o;\n    $phone-icon: $fa-var-phone;\n    $mobile-icon: $fa-var-mobile;\n    $fax-icon: $fa-var-print;\n\n## Troubleshooting\n\n#### Cannot load such file -- sass/script/node (LoadError)\n\nFor some reasons there is a bug when installing the latest version of Compass... your install of Sass get messed up (I didn't have time to investigate: if you have a better workaround/explanation let me know). \n\nTo get over it just uninstall sass and install it again:\n\n    $ gem uninstall sass\n    $ gem install sass\n\n#### Cannot load RubyCocoa library\n\nWhen trying to install wkpdf on MacOsx you may be told that *wkpdf requires that RubyCocoa is installed...* The fact is that using wkpdf with non-default Ruby installations is not supported.\n\nYou must install wkpdf with the native ruby packaged on your mac:\n- https://github.com/plessl/wkpdf/issues/36\n- https://github.com/sstephenson/rbenv/issues/270\n\nYou can use *rvm* or simply do:\n\n    $ sudo /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/gem install wkpdf\n\nTo check if your install is correct be sure that the first line of */usr/bin/wkpdf* file looks like the following:\n\n    #!/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarraq%2Fpandoc-moderncv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarraq%2Fpandoc-moderncv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarraq%2Fpandoc-moderncv/lists"}