{"id":13556197,"url":"https://github.com/there4/markdown-resume","last_synced_at":"2025-05-15T02:06:16.118Z","repository":{"id":2590054,"uuid":"3571772","full_name":"there4/markdown-resume","owner":"there4","description":"Generate a responsive CSS3 and HTML5 resume with Markdown, with optional PDF output.","archived":false,"fork":false,"pushed_at":"2023-03-18T05:20:54.000Z","size":10654,"stargazers_count":1777,"open_issues_count":19,"forks_count":515,"subscribers_count":60,"default_branch":"master","last_synced_at":"2025-04-13T23:54:26.383Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Less","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/there4.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2012-02-28T14:28:58.000Z","updated_at":"2025-04-05T13:00:04.000Z","dependencies_parsed_at":"2023-07-08T04:01:31.729Z","dependency_job_id":null,"html_url":"https://github.com/there4/markdown-resume","commit_stats":{"total_commits":128,"total_committers":26,"mean_commits":4.923076923076923,"dds":0.4921875,"last_synced_commit":"317f33e33c584be56c6c48fcf2deb211a7278075"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/there4%2Fmarkdown-resume","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/there4%2Fmarkdown-resume/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/there4%2Fmarkdown-resume/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/there4%2Fmarkdown-resume/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/there4","download_url":"https://codeload.github.com/there4/markdown-resume/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254259370,"owners_count":22040819,"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-01T12:03:41.609Z","updated_at":"2025-05-15T02:06:16.097Z","avatar_url":"https://github.com/there4.png","language":"Less","readme":"# Markdown Resume Generator [![Build Status](https://travis-ci.org/there4/markdown-resume.png?branch=master)](https://travis-ci.org/there4/markdown-resume)[![nodesource/node](http://dockeri.co/image/there4/markdown-resume)](https://registry.hub.docker.com/u/there4/markdown-resume/)\n\n\u003e Convert markdown to HTML and PDF resumes\n\nTurn a simple Markdown document into an elegant resume with both a perfect\npdf printable format, and a responsive css3 html5 file. You can view a sample\nat the [blog post for the project][blog], or look in examples/output to see sample PDFs.\n\n## Features\n\n* Multiple styles to choose from: `modern`, `blockish`, `unstyled`, `readable`, `swissen` _(Fork and add more!)_\n* PDF generation via [wkhtmltopdf][wkhtmltopdf]\n* Responsive design for multiple device viewport sizes\n* Simple Markdown formatting\n* Single file deployment (no external stylesheets)\n* You can now version control and branch your resume.\n\n## Installation\n\n### Docker\n\nRun those commands in the directory where you put your markdown resume.\n\n#### Oneshot command\n\nThis is best suited for use in scripts or in CI environments:\n\n`docker run -v ${PWD}:/resume there4/markdown-resume md2resume [options] command [arguments]`\n\n#### Interactive console\n\nThis allows you to enter an interactive console where you can easily experiment and run different commands:\n\n`docker run -it -v ${PWD}:/resume there4/markdown-resume`\n\n### Local\n\n1. Clone the repo `git clone git@github.com:there4/markdown-resume.git` or [Download ZIP](https://github.com/there4/markdown-resume/archive/master.zip)\n2. **PHP 7** and **[composer](https://getcomposer.org/download/)** are installed and on your PATH\n3. `composer install` inside of the project directory to install dependencies\n\n4. For generating PDF files, you need to install `wkhtmltopdf`\n    * OSX: `brew cask install wkhtmltopdf` via [Homebrew Cask](https://caskroom.github.io/)\n    * Debian: `sudo apt install php7.0-mbstring wkhtmltopdf`\n    * Fedora `sudo dnf install php-mbstring wkhtmltopdf`\n\n## Usage\n\nThe two most important commands are the following two. Run them\ninside the cloned directory\n\n```bash\n./bin/md2resume html examples/source/sample.md examples/output/\n./bin/md2resume pdf examples/source/sample.md examples/output/\n```\n\n## Help\n\n```\nMarkdown Resume Generator version 2.3.0 by Craig Davis\n\nUsage:\n  [options] command [arguments]\n\nOptions:\n  --help           -h Display this help message.\n  --quiet          -q Do not output any message.\n  --verbose        -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug\n  --version        -V Display this application version.\n  --ansi              Force ANSI output.\n  --no-ansi           Disable ANSI output.\n  --no-interaction -n Do not ask any interactive question.\n\nAvailable commands:\n  help        Displays help for a command\n  html        Generate an HTML resume from a markdown file\n  list        Lists commands\n  pdf         Generate a PDF from a markdown file\n  stats       Generate a word frequency analysis of your resume\n  templates   List available templates\n  version     Show current version information\n\n```\n\n## Examples\n\nChoose a template with the -t option.\n\n```bash\n./bin/md2resume html --template blockish examples/source/sample.md examples/output/\n```\n\nIf you want to edit your markdown resume in your editor while watching it\nupdate in your browser, run this command:\n\n```bash\nwatch ./bin/md2resume html --refresh yes --template modern examples/source/sample.md examples/output/\n```\n\nThis makes the build script run periodically, and html document will refresh\nevery two seconds via a meta tag. Open the `./examples/ouput/sample.html` file\nin your browser, and then just save your markdown document when you want to see\na fresh preview.\n\n## Authoring Your Resume\n\nMarkdown is limited to basic html markup. Follow the `examples/source/sample.md`\nfile  as a guideline. This file includes various headers and several nested\nelements. This allows us to construct a semantic HTML document for the resume,\nand then use CSS rules to display a nicely formatted resume. Note that because\nwe have very few ways to nest or identify elements that many of the css rules\nare based on descendant and adjacent selectors.\n\n## Feature Development\n\nIn order to add new commands, you'll need to first install the dependencies via `composer install`\n\nAfter that, you can run the `md2resume_dev.php` file from the command line.\n\n## Building a Release\n\n1. Tag the repo with the new build number.\n2. Run `composer build`.\n3. Push both the tag and the code.\n\n## Acknowledgments\n\nThe initial inspiration is from the [Sample Resume Template][srt].\nHowever, no HTML from that project has been used in this. General layout has\nbeen reused, and media queries have been added. It's a nice template, and if you\nare a more comfortable with html than markdown, you should use it.\n\n## Changelog\n\n* __2.3.1__ : Fix embedded images in PDF generation with Docker  [@danielklim](https://github.com/danielklim)\n* __2.3.0__ : Add Docker support to ease the installation process  [@spawnia](https://github.com/spawnia)\n* __2.2.0__ : Dropped phar file distribution, removed Pake and migrated to composer commands\n* __2.1.0__ : Dropped PHP5 support\n* __2.0.12__ : Added new `Roboto` template from [@ejwaibel](https://github.com/ejwaibel)\n* __2.0.10__ : Updated spacing in moder template with commites from [@501st-alpha1](https://github.com/501st-alpha1)\n* __2.0.9__ : Updated Modern template with improved spacing. Update parsing of\n  `--template` option to close [issue #7](https://github.com/there4/markdown-resume/issues/7)\n* __2.0.8__ : New `readable` theme contributed by @ahmadnazir, minor refactor\n  to support a /links directory\n* __2.0.7__ : Update composer to use `sunra/php-simple-html-dom-parser` this\n  appears to be better maintained and more popular to [close #27](https://github.com/there4/markdown-resume/issues/27)\n* __2.0.6__ : Fix empty template list from phar file to [close #24](https://github.com/there4/markdown-resume/issues/24)\n* __2.0.5__ : Remove default value for the `--refresh` option to [close #22](https://github.com/there4/markdown-resume/issues/22)\n* __2.0.4__ : Fix path resolution problem with absolute paths to [close #16](https://github.com/there4/markdown-resume/issues/16)\n* __2.0.3__ : Add optional duration to the `--refresh` option to [close #15](https://github.com/there4/markdown-resume/issues/15)\n* __2.0.2__ : Add new dependency check for `mbstring` to [close #20](https://github.com/there4/markdown-resume/issues/20)\n* __2.0.1__ : Add new `swissen` template with Helvetica styling [@beautifulcode](https://github.com/beautifulcode)\n* __2.0.0__ : Complete rewrite with the [symfony console component][console].\n  Deployment is now done with a compiled phar file, and development dependencies\n  are managed with composer.\n* __0.9.0__ : Add composer and update README with new changelog\n* __0.8.8__ : Add Chinese text example [@ishitcno1](https://github.com/ishitcno1)\n* __0.8.7__ : Update pdf formatting of the modern template [@roleary](https://github.com/roleary)\n* __0.8.6__ : Fix output path [@abhikandoi2000](https://github.com/abhikandoi2000)\n* __0.8.5__ : Fix [issue #2](https://github.com/there4/markdown-resume/issues/2)\n* __0.8.4__ : Correct chmod and add parameter for output directory [@kevinxucs](https://github.com/kevinxucs)\n* __0.8.2__ : Update build script and add refresh command option\n* __0.8.1__ : Updating formatting of initial templates\n* __0.8__ : Initial Release to Public\n\n[srt]: http://sampleresumetemplate.net/ \"A great starting point\"\n[blog]: http://there4development.com/blog/2012/12/31/markdown-resume-builder/\n[pake]: https://github.com/indeyets/pake/wiki/Installing-Pake\n[wkhtmltopdf]: https://github.com/pdfkit/pdfkit/wiki/Installing-WKHTMLTOPDF\n[console]: http://symfony.com/doc/current/components/console/introduction.html\n","funding_links":[],"categories":["Less","PHP","CSS","📦 Legacy \u0026 Inactive Projects","others","Tools"],"sub_categories":["Converters"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthere4%2Fmarkdown-resume","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthere4%2Fmarkdown-resume","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthere4%2Fmarkdown-resume/lists"}